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

doc: add Table of Contents to Cpp style guide #17052

Closed
wants to merge 1 commit into from

Conversation

fhinkel
Copy link
Member

@fhinkel fhinkel commented Nov 15, 2017

The Cpp style guide is growing. IMHO, a Table of Contents makes
it easier to navigate.

I checked all the anchors and made sure they work.

Checklist
Affected core subsystem(s)

doc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 15, 2017
The Cpp style guide is growing. IMHO, a Table of Contents makes
it easier to navigate.
@fhinkel fhinkel changed the title doc: add Table of Contents to Cpp styleguide doc: add Table of Contents to Cpp style guide Nov 15, 2017
@@ -1,5 +1,22 @@
# C++ Style Guide

## Table of Contents

* [Left-leaning (C++ style) asterisks for pointer declarations](#left-leaning-c-style-asterisks-for-pointer-declarations)
Copy link
Member

@joyeecheung joyeecheung Nov 15, 2017

Choose a reason for hiding this comment

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

Can we group the rules into different categories? For what we have here I think we should at least have "formatting", "memory management" and "others", also I would expect more from "C++ and JavaScript interfacing"

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure. Is it OK to do that in a separate PR?

Copy link
Member

Choose a reason for hiding this comment

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

@fhinkel Of course!

@fhinkel fhinkel added the fast-track PRs that do not need to wait for 48 hours to land. label Nov 15, 2017
@fhinkel
Copy link
Member Author

fhinkel commented Nov 16, 2017

Thanks for the reviews. Fast-track landed in ed0327b (uncontroversial doc change).

@fhinkel fhinkel closed this Nov 16, 2017
fhinkel added a commit that referenced this pull request Nov 16, 2017
The Cpp style guide is growing. IMHO, a Table of Contents makes
it easier to navigate.

PR-URL: #17052
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
fhinkel added a commit to fhinkel/node that referenced this pull request Dec 3, 2017
fhinkel added a commit to fhinkel/node that referenced this pull request Dec 3, 2017
Ref: nodejs#17052 (comment)

PR-URL: nodejs#17095
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 11, 2017
The Cpp style guide is growing. IMHO, a Table of Contents makes
it easier to navigate.

PR-URL: #17052
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
Ref: #17052 (comment)

PR-URL: #17095
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
Ref: #17052 (comment)

PR-URL: #17095
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Dec 12, 2017
gibfahn pushed a commit that referenced this pull request Dec 19, 2017
The Cpp style guide is growing. IMHO, a Table of Contents makes
it easier to navigate.

PR-URL: #17052
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
Ref: #17052 (comment)

PR-URL: #17095
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@gibfahn gibfahn mentioned this pull request Dec 20, 2017
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
The Cpp style guide is growing. IMHO, a Table of Contents makes
it easier to navigate.

PR-URL: #17052
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
Ref: #17052 (comment)

PR-URL: #17095
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@gibfahn gibfahn mentioned this pull request Dec 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants