Skip to content

Add a terminology section to the docs style guide #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abarth merged 1 commit into from
Sep 12, 2016
Merged

Add a terminology section to the docs style guide #274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,12 @@ abstract class Picture ...
If writing the documentation proves to be difficult because the API is
convoluted, then rewrite the API rather than trying to document it.

### Canonical terminology

The documentation should use consistent terminology:

* method - a member of a class that is a non-anonymous closure
* function - a callable non-anonymous closure that isn't a member of a class

Coding patterns and catching bugs early
---------------------------------------
Expand Down