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

Remove SHOUTY BANNERS #2074

Merged
merged 30 commits into from
Aug 6, 2021
Merged

Remove SHOUTY BANNERS #2074

merged 30 commits into from
Aug 6, 2021

Conversation

SuperWig
Copy link
Contributor

@SuperWig SuperWig commented Jul 22, 2021

Continuation of #2072. I kept getting issues with the uppercase name of the branch so I renamed it. Didn't think it would close the PR 😕.

Fixes #306

stl/src/locale0.cpp Outdated Show resolved Hide resolved
stl/inc/xutility Outdated Show resolved Hide resolved
stl/src/locale.cpp Outdated Show resolved Hide resolved
@SuperWig
Copy link
Contributor Author

That is almost all of them now. Will finish up tomorrow along with fixing my inevitable mistakes.

@CaseyCarter CaseyCarter added the documentation Related to documentation or comments label Jul 22, 2021
Copy link
Member

@CaseyCarter CaseyCarter left a comment

Choose a reason for hiding this comment

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

This is mostly looking good, just a few places where the comment was GARBAGE name [other stuff..] for which I think the [other stuff...] was just barely useful enough to keep.

stl/inc/functional Outdated Show resolved Hide resolved
stl/inc/charconv Show resolved Hide resolved
stl/src/iomanip.cpp Show resolved Hide resolved
stl/src/locale.cpp Outdated Show resolved Hide resolved
stl/inc/xstddef Show resolved Hide resolved
stl/inc/xhash Show resolved Hide resolved
stl/inc/xmemory Show resolved Hide resolved
stl/inc/xutility Show resolved Hide resolved
@SuperWig SuperWig requested a review from a team as a code owner July 23, 2021 17:48
@fsb4000
Copy link
Contributor

fsb4000 commented Jul 24, 2021

add

Fixes #306

to your first comment.

Copy link
Contributor

@AlexGuteniev AlexGuteniev left a comment

Choose a reason for hiding this comment

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

I think some macro comments should be preserved. They give non obvious context, since macros lack type system, and these particular are not even verbose.

stl/src/xmath.hpp Show resolved Hide resolved
stl/src/xmath.hpp Show resolved Hide resolved
stl/inc/ymath.h Show resolved Hide resolved
@StephanTLavavej StephanTLavavej self-assigned this Jul 28, 2021
Copy link
Member

@StephanTLavavej StephanTLavavej left a comment

Choose a reason for hiding this comment

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

Thanks - I'll go ahead and push minor changes.

stl/inc/charconv Show resolved Hide resolved
stl/inc/variant Show resolved Hide resolved
stl/inc/variant Show resolved Hide resolved
@StephanTLavavej
Copy link
Member

Ok, I've pushed a merge with main (trivial to resolve - recent PRs added/altered code around stable name removals) and the following:

  • Restore stable names for optional and variant.
  • In variant/optional, drop more shouty banners but keep stable names.
  • Remove many more shouty banners.
  • Rework shouty banners to preserve info.

In optional and variant I'd be happy to remove those stable name citations entirely, but as some were already present with lowercase comments like:

// assignment [variant.assign]

I felt it was more consistent to keep them for now.

@StephanTLavavej StephanTLavavej removed their assignment Aug 4, 2021
@StephanTLavavej
Copy link
Member

Removed the optional/variant stable name comments (including the ones of the form // assignment [optional.object.assign]) after @CaseyCarter confirmed they weren't desired.

@StephanTLavavej StephanTLavavej self-assigned this Aug 5, 2021
@StephanTLavavej StephanTLavavej merged commit 4721611 into microsoft:main Aug 6, 2021
@StephanTLavavej
Copy link
Member

THANKS FOR CLEANING UP THESE COMMENTS! 😹

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.

STL: WE SHOULD REMOVE THE SHOUTY COMMENT BANNERS!
5 participants