[SERVER-35470] Write TypedCommand documentation and examples Created: 06/Jun/18  Updated: 06/Dec/22

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

Type: Improvement Priority: Minor - P4
Reporter: Billy Donahue Assignee: Backlog - Service Architecture
Resolution: Unresolved Votes: 0
Labels: sa-remove-fv-backlog-22
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Assigned Teams:
Service Arch
Participants:

 Description   

We need expanded documentation for TypedCommand. In general, it lacks documentation in these ways:

  • We should introduce a canonical example TypedCommand implementation. We will probably need to introduce a toy jstest to use the command. This mirrors the documentation examples for ServerParameters here.
  • We should create a document describing in prose how and why one creates a TypedCommand as docs/typed_command.md which is referenced in src/mongo/db/README.md.
  • We should expand the class comment for TypedCommand here to detail how to extend its nested classes and why the hierarchy is as it is---for dependent type lookup on TypedCommand<T>::Invocation. Implementers seem to have the most frustration when attempting to understanding this web of types.

Generated at Thu Feb 08 04:39:55 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.