Sync with upstream 2025-08 #58

jwnimmer-tri · 2025-08-29T03:09:46Z

FYI For reviewers:

I've configured Reviewable now to only show files that are relevant to Drake. Everything else is binned in a "vendored" grouping.
r1 contains the merge commit with upstream.
r2+ are adjustments to (hopefully) keep the updates from upstream aligned with Drake conventions.
For a preview click here. Note that this live preview lacks a little supplemental styling (link icon, css style details, etc.) but is reasonable for reviewing text. See https://drake.mit.edu/documentation_instructions.html if you'd like a 100% authentic preview.

Highlights:

cpplint is deleted
new license
new section on concepts
new section on consteval & related
modules verboten
prefer converting a class using std::string(some_cord) instead of static_cast<std::string>(some_cord).

This change is

- Include friend types in class declaration order guidance. - Include previously omitted text (due to mismatched tags) about preferring int16_t over short, et cetera. - Function declarations: - Updated guidance for what comments should cover. - Add a C++ attribute example.

Update C++ style guide.

Update style guideline URL

PiperOrigin-RevId: 480954960

There is no Common Lisp operator named PRINT-UNPRINTABLE-OBJECT. Given the context, it is certain that PRINT-UNREADABLE-OBJECT (www.lispworks.com/documentation/lw51/CLHS/Body/m_pr_unr.htm) was meant instead.

Fix PRINT-UNPRINTABLE-OBJECT

Update ts styleguide with latest google version

PiperOrigin-RevId: 489165518

Go Style Guide

PiperOrigin-RevId: 489255983

Go: Fix a logic error in an example.

s/Vimscript/Vim script/

PiperOrigin-RevId: 489430034

PiperOrigin-RevId: 489956630

Add link to the Go guide from README.md.

PiperOrigin-RevId: 493761232

PiperOrigin-RevId: 497970050

…patch-1 Trivial typofix

Internal Change.

pylint triggered: pylint: Command line or configuration file:1: UserWarning: Specifying exception names in the overgeneral-exceptions option without module name is deprecated and support for it will be removed in pylint 3.0. Use fully qualified name (maybe 'builtins.StandardError' ?) instead. pylint: Command line or configuration file:1: UserWarning: Specifying exception names in the overgeneral-exceptions option without module name is deprecated and support for it will be removed in pylint 3.0. Use fully qualified name (maybe 'builtins.Exception' ?) instead. pylint: Command line or configuration file:1: UserWarning: Specifying exception names in the overgeneral-exceptions option without module name is deprecated and support for it will be removed in pylint 3.0. Use fully qualified name (maybe 'builtins.BaseException' ?) instead. Suggestion works out.

@algonell

contributed by @algonell.

PiperOrigin-RevId: 510217476

- Encourage use of the `internal` namespace to document parts of an API that are not public. - Create a separate section for `switch` statements. - Require a project-specific prefix for macros. - Reorganize guidance for formatting conditional statements. - Other miscellaneous wording and formatting fixes.

Update C++ style guide.

PiperOrigin-RevId: 522150370

Upstream's new text is exactly what we wanted, instead allowing the crazypants whitespace like prior guides.

jwnimmer-tri

@jwnimmer-tri reviewed 1 of 1 files at r5, all commit messages.
Reviewable status: LGTM missing from assignees rpoyner-tri(platform),ggould-tri(platform),sammy-tri(platform),SeanCurtis-TRI(platform),sherm1(platform) (waiting on @ggould-tri, @rpoyner-tri, @sammy-tri, @SeanCurtis-TRI, and @sherm1)

rpoyner-tri

@rpoyner-tri reviewed 44 of 44 files at r1, 1 of 2 files at r2, 1 of 1 files at r5, all commit messages.
Reviewable status: LGTM missing from assignees ggould-tri(platform),sammy-tri(platform),SeanCurtis-TRI(platform),sherm1(platform) (waiting on @ggould-tri, @sammy-tri, @SeanCurtis-TRI, and @sherm1)

sherm1

This is new for us, I believe:

When explicitly converting to a class type, use a function-style cast;
e.g., prefer std::string(some_cord) to
static_cast<std::string>(some_cord).

Checkpoint for r1

@sherm1 reviewed 44 of 44 files at r1.
Reviewable status: 1 unresolved discussion, LGTM missing from assignees ggould-tri(platform),sammy-tri(platform),SeanCurtis-TRI(platform),sherm1(platform) (waiting on @ggould-tri, @sammy-tri, and @SeanCurtis-TRI)

cppguide.html line 5176 at r1 (raw file):

are mixed case with the first letter of each word capitalized
("<a href="https://en.wikipedia.org/wiki/Camel_case">camelCase</a>" or
"<a href="https://en.wiktionary.org/wiki/Pascal_case">PascalCase</a>").

BTW the above appears to approve of snake_case, PascalCase, and camelCase. I don't think we ever permit camelCase (initial lower case)?

sherm1

with one question below. Also, we should announce the new conversion style noted above. I like it!

@sherm1 reviewed 1 of 2 files at r2, 1 of 1 files at r5, all commit messages.
Reviewable status: 1 unresolved discussion, LGTM missing from assignees ggould-tri(platform),sammy-tri(platform),SeanCurtis-TRI(platform) (waiting on @ggould-tri, @jwnimmer-tri, @sammy-tri, and @SeanCurtis-TRI)

jwnimmer-tri

we should announce the new conversion style noted above.

For starters, I added it to the summary atop this PR.

@jwnimmer-tri reviewed 1 of 1 files at r6, all commit messages.
Reviewable status: LGTM missing from assignees ggould-tri(platform),sammy-tri(platform),SeanCurtis-TRI(platform) (waiting on @ggould-tri, @sammy-tri, and @SeanCurtis-TRI)

cppguide.html line 5176 at r1 (raw file):

Previously, sherm1 (Michael Sherman) wrote…

BTW the above appears to approve of snake_case, PascalCase, and camelCase. I don't think we ever permit camelCase (initial lower case)?

I think its point was to give names to the various styles in the world, without endorsement. Anyway, I pushed a clarification.

rpoyner-tri

@rpoyner-tri reviewed 1 of 1 files at r6, all commit messages.
Reviewable status: LGTM missing from assignees ggould-tri(platform),sammy-tri(platform),SeanCurtis-TRI(platform) (waiting on @ggould-tri, @sammy-tri, and @SeanCurtis-TRI)

sherm1

@sherm1 reviewed 1 of 1 files at r6, all commit messages.
Reviewable status: LGTM missing from assignees ggould-tri(platform),sammy-tri(platform),SeanCurtis-TRI(platform) (waiting on @ggould-tri, @sammy-tri, and @SeanCurtis-TRI)

SeanCurtis-TRI

With one comment.

@SeanCurtis-TRI reviewed 11 of 44 files at r1, 1 of 2 files at r2, 1 of 1 files at r6, all commit messages.
Reviewable status: 1 unresolved discussion, LGTM missing from assignees ggould-tri(platform),sammy-tri(platform) (waiting on @ggould-tri and @sammy-tri)

cppguide.html line 524 at r1 (raw file):

        <li>and the function is non-virtual,</li>
        <li>and the function is not recursive,</li>
        <li>and the function is "small" (~10 lines).</li>

BTW The new google documentation now calls out this size limit. We probably don't need to echo it?

jwnimmer-tri

Reviewable status: LGTM missing from assignees ggould-tri(platform),sammy-tri(platform) (waiting on @ggould-tri and @sammy-tri)

cppguide.html line 524 at r1 (raw file):

Previously, SeanCurtis-TRI (Sean Curtis) wrote…

BTW The new google documentation now calls out this size limit. We probably don't need to echo it?

So did the old upstream text (in a slightly different place). But in both cases, the upstream wording is more of a suggestion than a rule; here, we specifically strengthen it into a hard requirement.

SeanCurtis-TRI

Reviewable status: LGTM missing from assignees ggould-tri(platform),sammy-tri(platform) (waiting on @ggould-tri and @sammy-tri)

cppguide.html line 524 at r1 (raw file):

Previously, jwnimmer-tri (Jeremy Nimmer) wrote…

So did the old upstream text (in a slightly different place). But in both cases, the upstream wording is more of a suggestion than a rule; here, we specifically strengthen it into a hard requirement.

Sounds good.

jwnimmer-tri · 2025-09-10T14:55:16Z

Gentle reminder for @ggould-tri and @sammy-tri -- comments are due by next Monday, please.

sammy-tri

@sammy-tri reviewed 1 of 1 files at r6.
Reviewable status: LGTM missing from assignee ggould-tri(platform) (waiting on @ggould-tri)

ggould-tri

; sorry, thought I'd already punched this one.

Reviewable status: complete! all discussions resolved, LGTM from assignees rpoyner-tri(platform),ggould-tri(platform),sammy-tri(platform),SeanCurtis-TRI(platform),sherm1(platform),xuchen-han (waiting on @jwnimmer-tri)

FaresSalem and others added 30 commits October 6, 2020 17:15

Update style guideline URL

61bf629

Merge pull request google#699 from zetafunction/moo

e880840

Update C++ style guide.

Merge pull request google#580 from FaresSalem/gh-pages

099770e

Update style guideline URL

Project import generated by Copybara.

8638b26

PiperOrigin-RevId: 480954960

Fix PRINT-UNPRINTABLE-OBJECT

fbce7fd

There is no Common Lisp operator named PRINT-UNPRINTABLE-OBJECT. Given the context, it is certain that PRINT-UNREADABLE-OBJECT (www.lispworks.com/documentation/lw51/CLHS/Body/m_pr_unr.htm) was meant instead.

Merge pull request google#719 from phoe-trash/gh-pages

0b003a9

Fix PRINT-UNPRINTABLE-OBJECT

update ts styleguide with latest google version

fd8c548

Merge pull request google#727 from Cabbageboy/gh-pages

f3c2c7f

Update ts styleguide with latest google version

Add Google Go Style Guide.

e8424d7

PiperOrigin-RevId: 489165518

Merge pull request google#729 from gaal/go

d976b65

Go Style Guide

Fix a logic error in an example.

15c7fa0

PiperOrigin-RevId: 489255983

Merge pull request google#730 from gaal/go

2d5b76e

Go: Fix a logic error in an example.

Add Go CODEOWNERS.

317af04

Trivial typofix

7869982

s/Vimscript/Vim script/

Link to the Go style guide from README.md.

8828cd1

Internal Change.

9d68006

PiperOrigin-RevId: 489430034

Internal Change.

228e403

PiperOrigin-RevId: 489956630

Merge pull request google#731 from gaal/go

307bda3

Add link to the Go guide from README.md.

Merge branch 'gh-pages' into patch-1

54aad34

Project import generated by Copybara.

ec302b3

PiperOrigin-RevId: 493761232

Internal Change.

9ae38d4

PiperOrigin-RevId: 497970050

Vimscript -> Vim script : Merge pull request google#734 from ujihisa/…

b5c20ce

…patch-1 Trivial typofix

Merge pull request google#747 from Carrotman42/export_tmp

74605a6

Internal Change.

Add explicit module names to pylintrc to support pylint >= 3.0

f924e89

contributed by @algonell.

Project import generated by Copybara.

e065b55

PiperOrigin-RevId: 510217476

Merge pull request google#766 from zetafunction/update-styleguide

8042238

Update C++ style guide.

Project import generated by Copybara.

d2cc2a7

PiperOrigin-RevId: 522150370

jwnimmer-tri added 12 commits September 2, 2025 06:21

Inline functions: minor wordsmithing

a3ea9ef

Order of Includes: strikethrough new advice on angle includes

b1e6e85

Reference Arguments: fix styling

793c94b

Coroutines: do not use

6372562

Constant Names: fix formatting

ce98baa

Template Parameter Names: never constants

0ad90db

TODO Comments: More prescriptive

926371d

Authorship Comments: fix styling

c8a3b46

clang-format: fix styling

1d858bd

Raw String Literals: fix styling

5a71625

Pointer...Types: Remove drake customization

f50cb4f

Upstream's new text is exactly what we wanted, instead allowing the crazypants whitespace like prior guides.

Constant Names: don't use kPascalCase for template-varying constants

eae65d8

jwnimmer-tri force-pushed the sync-upstream-2025-08 branch from 11ab0d1 to eae65d8 Compare September 2, 2025 13:21

jwnimmer-tri commented Sep 2, 2025

View reviewed changes

rpoyner-tri reviewed Sep 2, 2025

View reviewed changes

sherm1 reviewed Sep 2, 2025

View reviewed changes

sherm1 reviewed Sep 3, 2025

View reviewed changes

clarify camelCase

a4136af

jwnimmer-tri commented Sep 3, 2025

View reviewed changes

rpoyner-tri reviewed Sep 3, 2025

View reviewed changes

sherm1 reviewed Sep 3, 2025

View reviewed changes

SeanCurtis-TRI reviewed Sep 4, 2025

View reviewed changes

jwnimmer-tri commented Sep 4, 2025

View reviewed changes

SeanCurtis-TRI reviewed Sep 4, 2025

View reviewed changes

sammy-tri reviewed Sep 10, 2025

View reviewed changes

ggould-tri reviewed Sep 10, 2025

View reviewed changes

rpoyner-tri merged commit 63d2e8e into RobotLocomotion:main Sep 10, 2025
1 check passed

jwnimmer-tri deleted the sync-upstream-2025-08 branch September 10, 2025 18:51

jwnimmer-tri mentioned this pull request Sep 10, 2025

[workspace] Upgrade styleguide to latest commit RobotLocomotion/drake#23419

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sync with upstream 2025-08 #58

Sync with upstream 2025-08 #58

Uh oh!

jwnimmer-tri commented Aug 29, 2025 •

edited

Loading

Uh oh!

jwnimmer-tri left a comment

Uh oh!

rpoyner-tri left a comment

Uh oh!

sherm1 left a comment

Uh oh!

sherm1 left a comment

Uh oh!

jwnimmer-tri left a comment

Uh oh!

rpoyner-tri left a comment

Uh oh!

sherm1 left a comment

Uh oh!

SeanCurtis-TRI left a comment

Uh oh!

jwnimmer-tri left a comment

Uh oh!

SeanCurtis-TRI left a comment

Uh oh!

jwnimmer-tri commented Sep 10, 2025

Uh oh!

sammy-tri left a comment

Uh oh!

ggould-tri left a comment

Uh oh!

Uh oh!

Uh oh!

Sync with upstream 2025-08 #58

Sync with upstream 2025-08 #58

Uh oh!

Conversation

jwnimmer-tri commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jwnimmer-tri left a comment

Choose a reason for hiding this comment

Uh oh!

rpoyner-tri left a comment

Choose a reason for hiding this comment

Uh oh!

sherm1 left a comment

Choose a reason for hiding this comment

Uh oh!

sherm1 left a comment

Choose a reason for hiding this comment

Uh oh!

jwnimmer-tri left a comment

Choose a reason for hiding this comment

Uh oh!

rpoyner-tri left a comment

Choose a reason for hiding this comment

Uh oh!

sherm1 left a comment

Choose a reason for hiding this comment

Uh oh!

SeanCurtis-TRI left a comment

Choose a reason for hiding this comment

Uh oh!

jwnimmer-tri left a comment

Choose a reason for hiding this comment

Uh oh!

SeanCurtis-TRI left a comment

Choose a reason for hiding this comment

Uh oh!

jwnimmer-tri commented Sep 10, 2025

Uh oh!

sammy-tri left a comment

Choose a reason for hiding this comment

Uh oh!

ggould-tri left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jwnimmer-tri commented Aug 29, 2025 •

edited

Loading