mirror/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2026-01-27 04:24:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] Languages in Examples (#15697)

Browse Source 
* [DOC] Languages in Examples

* Update doc/contributing/documentation_guide.md

Co-authored-by: Jeremy Evans <code@jeremyevans.net>

* Update doc/contributing/documentation_guide.md

Co-authored-by: Jeremy Evans <code@jeremyevans.net>

---------

Co-authored-by: Jeremy Evans <code@jeremyevans.net>
This commit is contained in:
Burdette Lamar 2025-12-22 16:52:52 -06:00 committed by GitHub
parent af30e4714c
commit e69f41a0a8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
Notes: git 2025-12-22 22:53:20 +00:00 
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/contributing/documentation_guide.md
View File

@ -326,6 +326,16 @@ Alternatives:
- Example {source}[https://github.com/ruby/ruby/blob/34d802f32f00df1ac0220b62f72605827c16bad8/doc/contributing/glossary.md?plain=1].
- Corresponding {output}[https://docs.ruby-lang.org/en/master/contributing/glossary_md.html].
### Languages in Examples
For symbols and strings in documentation examples:
- Prefer \English in \English documentation: <tt>'Hello'</tt>.
- Prefer Japanese in Japanese documentation: <tt>'こんにちは'</tt>.
- If a second language is needed (as, for example, characters with different byte-sizes),
prefer Japanese in \English documentation and \English in Japanese documentation.
- Use other languages examples only as necessary: see String#capitalize.
## Documenting Classes and Modules
The general structure of the class or module documentation should be: