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.

Sign up for GitHub

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

Jump to bottom

http2: Correcting the heading format #22262

Closed
wants to merge 1 commit into from
Closed

http2: Correcting the heading format #22262

wants to merge 1 commit into from

Conversation

antsmartian
Copy link
Contributor

@antsmartian antsmartian commented Aug 11, 2018 •
edited

Was reading http2 docs and found this issue. Looks like a heading doesn't need code tags (``).

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem. labels Aug 11, 2018
@trivikr
Copy link
Member

trivikr commented Aug 11, 2018

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/517/

@trivikr trivikr added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 11, 2018
@Trott
Copy link
Member

Trott commented Aug 11, 2018

@vsemozhetbyt @rubys (just to get the eyes of the people most familiar with our current markdown processing quirks and bugs)

@vsemozhetbyt
Copy link
Contributor

This is indeed a regression in the new toolchain, but it should be fixed eventually in the #22140 (checked and confirmed in #22140 (comment))

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Aug 11, 2018 •
edited

We usually do not use backticks in API headings (when all the heading needs to be wrapped in backticks) and do use them for code entities in common headings.

@gdams
Copy link
Member

gdams commented Aug 14, 2018

@antsmartian can you please resolve the conflicts?

vsemozhetbyt
vsemozhetbyt reviewed Aug 14, 2018
View reviewed changes
doc/api/http2.md Outdated
@@ -108,13 +108,14 @@ have occasion to work with the `Http2Session` object directly, with most
actions typically taken through interactions with either the `Http2Server` or
`Http2Stream` objects.


#### Http2Session and Sockets
Copy link
Contributor

Choose a reason for hiding this comment

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

Is moving the heading intentional? It seems the next paragraph is out of topic now?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope, I tried to resolve conflicts via browser and things didn't went well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will squash my commits and update the PR.

@antsmartian
Copy link
Contributor Author

@vsemozhetbyt Now it should be good to go. cc @gdams fixed the conflicts.

@gdams
Copy link
Member

gdams commented Aug 14, 2018

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/563/

@gdams
Copy link
Member

gdams commented Aug 14, 2018

landed in: fc84666

@gdams gdams closed this Aug 14, 2018
gdams pushed a commit that referenced this pull request Aug 14, 2018
@antsmartian
http2: correcting the heading format
fc84666 
PR-URL: #22262
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
@antsmartian antsmartian deleted the http2_doc_fix branch August 15, 2018 02:30
rvagg pushed a commit that referenced this pull request Aug 15, 2018
@antsmartian @rvagg
http2: correcting the heading format
535e0e5 
PR-URL: #22262
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
@rvagg rvagg mentioned this pull request Aug 15, 2018
Merged
This was referenced Aug 16, 2018
Closed
Closed
Closed
Closed
Closed
Closed
This was referenced Aug 16, 2018
Closed
Closed
Closed
Closed
@addaleax addaleax mentioned this pull request Oct 20, 2018
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsemozhetbyt vsemozhetbyt vsemozhetbyt left review comments

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott approved these changes

@trivikr trivikr trivikr approved these changes

@gdams gdams gdams approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@antsmartian @trivikr @Trott @vsemozhetbyt @gdams @jasnell @nodejs-github-bot