[SERVER-14292] Prevent the contents of db.help() getting out of date Created: 18/Jun/14  Updated: 10/May/22

Status: Backlog
Project: Core Server
Component/s: Shell
Affects Version/s: 2.6.2
Fix Version/s: None

Type: Improvement Priority: Minor - P4
Reporter: Andre de Frere Assignee: DO NOT USE - Backlog - Platform Team
Resolution: Unresolved Votes: 0
Labels: community-team, move-sa
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Participants:
Case:

 Description   

The contents of db.help() are hardcoded, but often get out of date (when adding new shell helpers etc).

The results from db.help() should at least reflect what is possible from tab completion in the shell (db.<tab><tab>).



 Comments   
Comment by Steven Vannelli [ 10/May/22 ]

Moving this ticket to the Backlog and removing the "Backlog" fixVersion as per our latest policy for using fixVersions.

Comment by Matt Kangas [ 19/Jun/14 ]

We should be able to add a test which alerts us when db.help() results are out of sync with reality.

Tab completion values originate here:
https://github.com/mongodb/mongo/blame/r2.7.2/src/mongo/shell/utils.js#L467-L475

db.help() defined here:
https://github.com/mongodb/mongo/blame/r2.7.2/src/mongo/shell/db.js#L265-L316

Generated at Thu Feb 08 03:34:24 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.