Code review comment for ~bloodearnest/snapstore-client:api-docs

Revision history for this message
Daniel Manrique (roadmr) wrote :

There's some pseudoformat in this document which suggests the intent is markdown rather than rst, in which case I'd suggest checking it with e.g. python-markdown, because right now it doesn't render very nicely. Even if it's not intended for rendering, it'd make sense to still adhere to markdown so it *can* be rendered :)

I was initially super confused and was about to suggest this document was too unfriendly, but then went back and realized the audience are developers who'll interact with the API, so it should be OK to be a bit rough on them.

Also caught some typos and other minor things below.

review: Needs Fixing

« Back to merge proposal