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 missing introduced_in comments #16741

Closed
wants to merge 1 commit into from

Conversation

lpinca
Copy link
Member

@lpinca lpinca commented Nov 4, 2017

Add missing "introduced_in" comments for alternative version links.

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

doc

Add missing "introduced_in" comments for alternative version links.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 4, 2017
@@ -1,6 +1,6 @@
# ECMAScript Modules

<!--introduced_in=v9.x.x-->
<!--introduced_in=v8.5.0-->
Copy link
Member

Choose a reason for hiding this comment

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

Non-blocking nit/question: Is the helpful/interesting information to include when the feature was introduced as Experimental or is it when it is introduced as Stable? I would argue Stable is what I'd expect to see and what would be useful when looking in docs. In which case, this probably should stay as is?

Copy link
Member Author

@lpinca lpinca Nov 5, 2017

Choose a reason for hiding this comment

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

I think this should use the first version in which the feature was documented regardless of the stability. Aren't docs for an experimental feature useful? If so why adding them in the first place?

That said, I'm fine with changing/removing the comment in all experimental modules/features.

@@ -1,5 +1,7 @@
# HTTP2

<!--introduced_in=v8.4.0-->
Copy link
Member

Choose a reason for hiding this comment

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

Same "Stable or Experimental?" questions as above.

@lpinca
Copy link
Member Author

lpinca commented Nov 19, 2017

lpinca added a commit to lpinca/node that referenced this pull request Nov 19, 2017
Add missing "introduced_in" comments for alternative version links.

PR-URL: nodejs#16741
Reviewed-By: Anatoli Papirovski <[email protected]>
@lpinca
Copy link
Member Author

lpinca commented Nov 19, 2017

Landed in 97ba69f.

@lpinca lpinca closed this Nov 19, 2017
@lpinca lpinca deleted the add/introduced_in-comments branch November 19, 2017 17:27
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
Add missing "introduced_in" comments for alternative version links.

PR-URL: #16741
Reviewed-By: Anatoli Papirovski <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Dec 12, 2017
gibfahn pushed a commit that referenced this pull request Dec 19, 2017
Add missing "introduced_in" comments for alternative version links.

PR-URL: #16741
Reviewed-By: Anatoli Papirovski <[email protected]>
@gibfahn gibfahn mentioned this pull request Dec 20, 2017
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
Add missing "introduced_in" comments for alternative version links.

PR-URL: #16741
Reviewed-By: Anatoli Papirovski <[email protected]>
@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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants