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

cppguide: fix html markup & namespace #716

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from

Conversation

parmaski
Copy link

  • Added missing std:: namespace to classes in the standard library e.g., string_view.
  • Added missing <code> tag to keywords and file extensions where missing.
  • Fixed all paragraphs to use <p> tag.
  • Removed unnecessary <div> tags.

Copy link
Contributor

@tituswinters tituswinters left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! The source of truth for this is internal, but I'm porting most of these changes over to that doc so these will be reflected on the next update.

That said, there's a couple things that will probably be a little iffy:

  • We're not explicitly saying std::string_view yet because of minor compatibility differences between absl::string_view and std::string_view (mostly regarding construction from a single nullptr). So we're leaving the unqualified names in place as an intentional ambiguity.
  • There's a bunch of random
    s that are coming from the upstream source-of-truth having divs for internal/external-only stanzas. Unless those are causing harm, I think they're relatively likely to keep popping up.

I think I've tidied up the full qualification for other types and other general use of and

tags.

@parmaski
Copy link
Author

Thank you for merging to the source-of-truth! It's helpful for machine translation.

@tituswinters
Copy link
Contributor

It did get committed up-stream, I expect we'll sync this in the next month (but could do so sooner if it matters to you).

Do the stray

tags cause problems?

@parmaski
Copy link
Author

Thanks a lot. I just wait the update.

<p> and <div> tags are not big problem.
I didn't know whether the HTML was hand-coded or auto-generated.
In the latter case, I don't mind.

@vapier vapier added the lang:cpp The C++ language label Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lang:cpp The C++ language
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants