Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-3509

Update in-repository documentation on new error types

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 4.1.1
    • Affects Version/s: None
    • Component/s: None
    • None
    • Not Needed

      Use Case

      As a user
      I want to have documentation consistent with the errors in the driver
      So that it is easy to understand what any given error means

      User Impact

      *What is the number of impacted customers? How severe is the impact? Is anyone blocked or broken?

      Dependencies

      Unknowns

      • questions that need to be answered to determine implementation

      Acceptance Criteria

      • Documentation in docs/errors.md and documentation in comments in src/errors.ts are consistent with each other
      • Diagrams in docs/errors.md reflect error class inheritance properly

      Documentation Requirements

      • DOCSP ticket, API docs, etc

      Follow Up Requirements

      • additional tickets to file, required releases, etc

            Assignee:
            warren.james@mongodb.com Warren James
            Reporter:
            warren.james@mongodb.com Warren James
            Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: