Back to all reviewers

Documentation clarity and formatting

apache/mxnet
Based on 3 comments
Markdown

When writing documentation (README files, tutorials, API docs), ensure clarity and proper formatting: 1. **Define technical terms and concepts** - Don't assume readers are familiar with specialized terminology. Include brief explanations and relevant links for reference.

Documentation Markdown

Reviewer Prompt

When writing documentation (README files, tutorials, API docs), ensure clarity and proper formatting:

  1. Define technical terms and concepts - Don’t assume readers are familiar with specialized terminology. Include brief explanations and relevant links for reference.
# Arguments
- batch_size: Define batch size (default=64)
- epochs: Define total epochs (default=1000)
- mu: Define μ in μ-Law encoding for audio quantization (see https://en.wikipedia.org/wiki/μ-law_algorithm)
  1. Understand markdown formatting rules - Be aware that formatting details like trailing spaces affect rendering. Double spaces at line ends create line breaks in markdown.

  2. Preview rendered output - Always check how documentation will actually appear to users before committing changes.

  3. Keep technical references current - When documenting code structures, ensure descriptions match the actual implementation. Update documentation when code interfaces change.

Following these practices ensures documentation is both technically accurate and genuinely helpful to other developers.

3
Comments Analyzed
Markdown
Primary Language
Documentation
Category

Source Discussions