-
Type:
Task
-
Resolution: Unresolved
-
Priority:
Major - P3
-
None
-
Component/s: Cross Spec Consistency
-
None
-
Not Needed
Summary
What is the problem or use case, what are we trying to achieve?
The standards defined in DRIVERS-3667 deferred rules for specification pseudocode until conversions of existing pseudocode took place.
Motivation
Who is the affected end user?
Who are the stakeholders?
All specification maintainers.
How does this affect the end user?
Are they blocked? Are they annoyed? Are they confused?
Inconsistency and confusion across specifications.
How likely is it that this problem or use case will occur?
Main path? Edge case?
There are multiple specifications containing non-compliant pseudocode.
If the problem does occur, what are the consequences and how severe are they?
Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete?
Inconsistency and confusion across specifications.
Is this issue urgent?
Does this ticket have a required timeline? What is it?
Not especially. Once this is completed all specifications will be in compliance with the new pseudocode standards.
Is this ticket required by a downstream team?
Needed by e.g. Atlas, Shell, Compass?
No.
Is this ticket only for tests?
Does this ticket have any functional impact, or is it just test improvements?
No functional or test impact.
Acceptance Criteria
What specific requirements must be met to consider the design phase complete?
All specification pseudocode must conform to the pseudocode standards defined below:
- Comments MUST follow the existing standards for prose style and formatting.
- Authors MUST use Python syntax for algorithms and Typescript syntax for BSON, wire documents, and API interfaces.
- Pseudocode MUST be purely explanatory, not normative. It cannot substitute for a prose description of a required
behavior.