Following up on a broader requirement/initiative to improve documentation of our error codes across all products.
Assuming I am looking at the right place, I have the following observations/feedback
- ObjC. https://docs.couchbase.com/mobile/3.0.0-beta02/couchbase-lite-objc/Constants.html.
Description is missing. I realize that CBLErrors.h header is included in the downloaded package. Is that what developers must refer to?
- Swift. Nothing in API docs. (looks like the ObjC constants get bridged up). How do swift developers find those in https://docs.couchbase.com/mobile/3.0.0-beta02/couchbase-lite-swift/. I realize that CBLErrors.h header is included in the downloaded package. Is that what developers must refer to?
Ideally, the goal of the initiative is to document error code, a brief description and brief remedial action.
In most cases on CBL, what needs to be done is self explanatory based on description. So it would be great to add missing the description consistently
The plan is to add direct link from our docs pages (under troubleshooting section)
If I should be looking elsewhere for error code documentation, let me know.
Just equivalent of https://docs.couchbase.com/mobile/3.0.0-beta02/couchbase-lite-net/api/Couchbase.Lite.CouchbaseLiteError.html
- is duplicated by
CBL-2550 Include description of error codes