[DOCS-335] Error Message Reference Created: 13/Jul/12 Updated: 30/Oct/23 Resolved: 18/May/16 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual |
| Affects Version/s: | None |
| Fix Version/s: | Server_Docs_20231030 |
| Type: | Tracking | Priority: | Major - P3 |
| Reporter: | Barrie Segal | Assignee: | Unassigned |
| Resolution: | Won't Fix | Votes: | 1 |
| Labels: | None | ||
| Σ Remaining Estimate: | Not Specified | Remaining Estimate: | Not Specified |
| Σ Time Spent: | Not Specified | Time Spent: | Not Specified |
| Σ Original Estimate: | Not Specified | Original Estimate: | Not Specified |
| Issue Links: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Sub-Tasks: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Participants: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Days since reply: | 7 years, 39 weeks ago | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Description |
|
The documentation should contain a reference for any error code a user might be faced with. |
| Comments |
| Comment by Emmanuel Bernard [ 18/May/16 ] |
|
For what it is worth, +1 on what Oliver said. Mapping framework and actual suer code defensive will want error code numbers. |
| Comment by Kay Kim (Inactive) [ 18/May/16 ] |
|
Fair enough and thanks for the input. Definitely will revisit the decision. We do currently have the error codes pages, and after we plan the best course of action for programmatically providing a complete code/message reference, can prioritize the project and do it in one fell swoop. |
| Comment by Oliver Gierke [ 18/May/16 ] |
|
I think that's a very, very bad idea. Human readers browsing a documentation is one thing but if I write some client software that interprets these errors (like e.g. here) I don't want to rely on looking for a message that could possibly change, internationalized at some point or the like. |
| Comment by Kay Kim (Inactive) [ 18/May/16 ] |
|
I'm going to close this because generally, we try to avoid documenting error codes – since they should include an err message that explains what the code is. We can revisit if we feel that the likelihood of error codes changing would be small. |
| Comment by Anne Moroney [ 03/Jun/14 ] |
|
I'm curious which part of this work is the duplicate of ; |
| Comment by auto [ 22/Aug/12 ] |
|
Author: {u'date': u'2012-08-22T13:17:50-07:00', u'email': u'samk@10gen.com', u'name': u'Sam Kleinman'}Message: merge: |
| Comment by auto [ 20/Aug/12 ] |
|
Author: {u'date': u'2012-08-20T14:38:25-07:00', u'email': u'samk@10gen.com', u'name': u'Sam Kleinman'}Message: merge: |
| Comment by auto [ 20/Aug/12 ] |
|
Author: {u'date': u'2012-08-20T13:54:37-07:00', u'email': u'samk@10gen.com', u'name': u'Sam Kleinman'}Message: merge: |