Surface EJSON tsdoc comments in BSON API docs

XMLWordPrintableJSON

    • None
    • None
    • None
    • None
    • None
    • None
    • None

      The documentation for our EJSON namespace does not get surfaced in the BSON documentation which forces us to duplicate our documentation to the js-bson readme.

      Use Case

      As a... Node Driver Engineer
      I want... EJSON API documentation to appear in the API docs
      So that... __ it is easier to maintain EJSON documentation and users can find it more easily.

      User Impact

      • This impacts us as developers as it means we have to maintain documentation for EJSON both in the tsdoc comments and in the js-bson readme
      • It leads to users having to look at two different sources for BSON and EJSON documentation.

      Dependencies

      • N/A

      Unknowns

      • Do we need to restructure the how the bson library exposes the EJSON namespace?

      Acceptance Criteria

      Documentation Requirements

      • Keep the UX of accessing EJSON functionality the same
      • Get the auto-generated docs to surface the documentation we have written in the tsdoc comments for EJSON

              Assignee:
              Unassigned
              Reporter:
              Warren James (Inactive)
              None
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: