Skip to content

standardize ^^^ x / !x vvv comments - #3208

Merged
Stephan T. Lavavej (StephanTLavavej) merged 3 commits into
microsoft:mainfrom
fsb4000:comments
Dec 6, 2022
Merged

standardize ^^^ x / !x vvv comments#3208
Stephan T. Lavavej (StephanTLavavej) merged 3 commits into
microsoft:mainfrom
fsb4000:comments

Conversation

@fsb4000

Copy link
Copy Markdown
Contributor

Sometimes we use // ^^^ no workaround / workaround vvv and sometimes // ^^^ no workaround // workaround vvv.
It looks like / is used more often. So I replaced all of // which I had found.
I used //.+// regexp and VS code.
Driven by: #3206 (comment)

@fsb4000
Igor Zhukov (fsb4000) requested a review from a team as a code owner November 13, 2022 17:37
@SuperWig

Copy link
Copy Markdown
Contributor

Should this PR also settle on double arrows or one on each side i.e.

^^^ _HAS_CXX20 ^^^/ vvv !_HAS_CXX20 vvv
vs
^^^ _HAS_CXX20 / !_HAS_CXX20 vvv

@fsb4000

Copy link
Copy Markdown
Contributor Author

Sure, and what do you like more?

@SuperWig

Copy link
Copy Markdown
Contributor

My vote would for the second. I believe this is also part of #351

@CaseyCarter Casey Carter (CaseyCarter) added the documentation Related to documentation or comments label Nov 14, 2022
@strega-nil-ms

Copy link
Copy Markdown
Contributor

I'll take a look at this once we discuss #351

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might as well standardize the location of the ^^^ and vvv as well; also do that through the rest of the file (probably should've just done one suggestion and then said that... sorry...)

Comment thread stl/inc/bitset Outdated
Comment thread stl/inc/deque Outdated
Comment thread stl/inc/execution Outdated
Comment thread stl/inc/execution Outdated
Comment thread stl/inc/list Outdated
Comment thread stl/inc/span Outdated
Comment thread stl/inc/span Outdated
Comment thread stl/inc/string Outdated
Comment thread stl/inc/vector Outdated
Comment thread stl/inc/vector Outdated
@strega-nil-ms nicole mazzuca (strega-nil-ms) changed the title replace // => / in comments standardize ^^^ x / !x vvv comments Dec 1, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making this more consistent and easier to read! The changes to <xcharconv_ryu.h> are fine (they're in additions to the upstream code and don't represent unnecessary divergence).

@StephanTLavavej

Copy link
Copy Markdown
Member

I'm mirroring this to the MSVC-internal repo - please notify me if any further changes are pushed.

@StephanTLavavej
Stephan T. Lavavej (StephanTLavavej) merged commit be29af2 into microsoft:main Dec 6, 2022
@StephanTLavavej

Copy link
Copy Markdown
Member

Thanks again for this consistency pass! 😸 🎉 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Related to documentation or comments

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants