search

google / styleguide

Style guides for Google-originated open-source projects
https://google.github.io/styleguide/
Apache License 2.0
37.53k stars 13.3k forks source link

Small clarification to class docstring examples #738

Closed anthonyburdi closed 1 year ago

anthonyburdi commented 1 year ago

Clarify that the first code snippet is the example to follow, and the second is not. This is clear from context if you read the paragraph above but not if you only look at the examples.

These style guides are copies of Google's internal style guides to assist developers working on Google owned and originated open source projects. Changes should be made to the internal style guide first and only then copied here.

Unsolicited pull requests will not be merged and are usually closed without comment. If a PR points out a simple mistake — a typo, a broken link, etc. — then the correction can be made internally and copied here through the usual process.

Substantive changes to the style rules and suggested new rules should not be submitted as a PR in this repository. Material changes must be proposed, discussed, and approved on the internal forums first.

google-cla[bot] commented 1 year ago

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

gpshead commented 1 year ago

thanks. the yes/no markers had been unintentionally omitted from those. an internal change addressing this was included as part of https://github.com/google/styleguide/commit/ec302b363edada1d696c476dcaf69f310755f823.