<commit_before>h2. API Documentation Guidelines

This guide documents the Ruby on Rails API documentation guidelines.

endprologue.

h3. RDoc

The Rails API documentation is generated with RDoc 2.5. Please consult the documentation for help with the "markup":http://rdoc.rubyforge.org/RDoc.html, and take into account also these "additional directives":http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html.<commit_msg>API guidelines: RDoc markup documentation has been moved in RDoc 3<commit_after>h2. API Documentation Guidelines

This guide documents the Ruby on Rails API documentation guidelines.

endprologue.

h3. RDoc

The Rails API documentation is generated with RDoc 2.5. Please consult the documentation for help with the "markup":http://rdoc.rubyforge.org/RDoc/Markup.html, and take into account also these "additional directives":http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html.
{'fraction_non_alphanumeric': 0.07674943566591422, 'fraction_numerical': 0.010158013544018058, 'mean_word_length': 5.075342465753424, 'pattern_counts': {'":': 4, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3630803', 'n_tokens_mistral': 268, 'n_tokens_neox': 241, 'n_words': 95}