Skip to content
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.

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

docs style: referring to function names #51

Closed
kelly-sovacool opened this issue Aug 8, 2024 · 0 comments
Closed

docs style: referring to function names #51

kelly-sovacool opened this issue Aug 8, 2024 · 0 comments
Assignees

Comments

@kelly-sovacool
Copy link

As a general rule, I recommend referring to specific functions as if they were proper names, followed by parentheses and enclosed in backticks. This helps make documentation more concise and easy to read.

For example, this sentence:

The add_total_count function will add total sample read numbers to the sample table.

Could be revised as:

add_total_count() will add total sample read numbers to the sample table.

As an added bonus, pkgdown will be able to turn that function reference into a hyperlink to its doc.

This is a soft recommendation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants