Pre-RFC: Documentation conventions

[benh]

If we’re specifying sections like parameters and examples and whatnot to ensure consistency, maybe we really want to switch to something more structured than markdown to get that sort of consistency out of the box.

[dhardy]

Personally I think using comments to disable blocks of code is wrong. In C/C++ I always use #if 0 ... #endif which (a) is nesting (though that isn’t a problem in Rust), (b) the editor usually highlights appropriately and © is obviously not a form of documentation. Shouldn’t there be an equivalent in Rust?

Otherwise, no comment, except that specifying American English seems a bit much.

[steveklabnik]

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.