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

Referring to quantities in documentation should use commas #1273

Open
vjeetje opened this issue Nov 22, 2023 · 0 comments
Open

Referring to quantities in documentation should use commas #1273

vjeetje opened this issue Nov 22, 2023 · 0 comments

Comments

@vjeetje
Copy link

vjeetje commented Nov 22, 2023

On https://google.aip.dev/132 we have this documentation:

  // The maximum number of books to return. The service may return fewer than
  // this value.
  // If unspecified, at most 50 books will be returned.
  // The maximum value is 1000; values above 1000 will be coerced to 1000.
  int32 page_size = 2;

The standard in American English is to separate 1000s by a comma. Suggestion is to replace these types of documentation with:

  // The maximum number of books to return. The service may return fewer than
  // this value.
  // If unspecified, at most 50 books will be returned.
  // The maximum value is 1,000; values above 1,000 will be coerced to 1,000.
  int32 page_size = 2;

Context: https://www.grammarbook.com/numbers/numbers.asp

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

1 participant