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

Typographical suggestions #23970

Closed
wants to merge 1 commit into from

Conversation

@denismcdonald
Copy link
Contributor

commented Oct 30, 2018

No description provided.

@Trott

This comment has been minimized.

@Trott Trott added the author ready label Oct 30, 2018

doc/api/synopsis.md Show resolved Hide resolved
@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor

commented Oct 30, 2018

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

@lpinca
lpinca approved these changes Oct 30, 2018
pull bot pushed a commit to SimenB/node that referenced this pull request Oct 30, 2018
doc: fix typographical issues
PR-URL: nodejs#23970
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor

commented Oct 30, 2018

Landed in 6f4721b
Thank you!

@refack

This comment has been minimized.

Copy link
Member

commented Oct 30, 2018

Hello @denismcdonald and thank you for the contribution.
I have a few questions for you regarding your experience submitting this PR. Are you available?

@denismcdonald

This comment has been minimized.

Copy link
Contributor Author

commented Oct 30, 2018

Hi there, @refack. Sure, how can I help?

@refack

This comment has been minimized.

Copy link
Member

commented Oct 31, 2018

Hello @denismcdonald,
I was wondering if while submitting the PR, our contribution guide was accessible, and easy to understand?
Some was complained that it's too long, or that the references are obscure. What was your experience?

@denismcdonald

This comment has been minimized.

Copy link
Contributor Author

commented Oct 31, 2018

Because of the nature of my PR, Refael (i.e., simply typographical, and relating only to the Node documentation), I don't think I can comment either way, I'm afraid.

Perhaps the only thing I could note (if it's of any use in improving the docs' "Edit on GitHub" process) is that I don't believe I was alerted, when submitting the PR, to the fact that a style guide existed for the docs, against which I could check any amendments I was suggesting. For it's only now, through you mentioning the contribution guide, that I see that a style guide does exist. But again, because the typographical errors I noticed were straightforward, it's not as though I was seeking guidance in that respect.

(Bear in mind, by the way, that I'm a Node beginner, and not experienced in submitting PRs, so perhaps I should apologise if I overlooked any requirements in submitting even a PR of this nature!)

@denismcdonald denismcdonald deleted the denismcdonald:patch-1 branch Oct 31, 2018

@refack

This comment has been minimized.

Copy link
Member

commented Oct 31, 2018

Bear in mind, by the way, that I'm a Node beginner, and not experienced in submitting PRs, so perhaps I should apologise if I overlooked any requirements in submitting even a PR of this nature!

Above all, I'd like to thank you for the contribution! 🥇 IMHO there is no need to apologize whatsoever.

Perhaps the only thing I could note (if it's of any use in improving the docs' "Edit on GitHub" process) is that I don't believe I was alerted

That's great feedback. Exactly what I was looking for. Thank you for that as well.

Hope we see you contribution more in the future. If you have any questions, feel free to contact me directly.

@refack refack removed the author ready label Oct 31, 2018

targos added a commit that referenced this pull request Nov 1, 2018
doc: fix typographical issues
PR-URL: #23970
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@targos targos referenced this pull request Nov 1, 2018
MylesBorins added a commit that referenced this pull request Nov 27, 2018
doc: fix typographical issues
PR-URL: #23970
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins added a commit that referenced this pull request Nov 27, 2018
doc: fix typographical issues
PR-URL: #23970
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@codebytere codebytere referenced this pull request Nov 27, 2018
rvagg added a commit that referenced this pull request Nov 28, 2018
doc: fix typographical issues
PR-URL: #23970
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
rvagg added a commit that referenced this pull request Nov 28, 2018
doc: fix typographical issues
PR-URL: #23970
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins added a commit that referenced this pull request Nov 29, 2018
doc: fix typographical issues
PR-URL: #23970
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@codebytere codebytere referenced this pull request Nov 29, 2018
@BethGriggs BethGriggs referenced this pull request Dec 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
10 participants
You can’t perform that action at this time.