Skip to content

doc: improvements to domain.markdown copy #4451

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
Closed
wants to merge 2 commits into from
Closed

doc: improvements to domain.markdown copy #4451

wants to merge 2 commits into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Dec 28, 2015

General improvements to the domain.markdown copy including
improved examples.

@jasnell jasnell added doc Issues and PRs related to the documentations. domain Issues and PRs related to the domain subsystem. lts-watch-v4.x labels Dec 28, 2015
@jasnell
Copy link
Member Author

jasnell commented Jan 5, 2016

@nodejs/documentation @misterdjules

Qard
Qard reviewed Jan 6, 2016
View reviewed changes
doc/api/domain.markdown Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Singular module?

@Qard
Copy link
Member

Qard commented Jan 6, 2016

Some minor nits, but LGTM when those are addressed.

jasnell added 2 commits January 6, 2016 08:41
@jasnell
doc: improvements to domain.markdown copy
6fee615 
General improvements to the domain.markdown copy including
improved examples.
@jasnell
doc: fix nits
c2ca566
@jasnell jasnell force-pushed the doc-domain-improvements branch from b85972d to c2ca566 Compare January 6, 2016 16:41
@jasnell
Copy link
Member Author

jasnell commented Jan 6, 2016

@Qard ... fixed!

misterdjules
misterdjules reviewed Jan 8, 2016
View reviewed changes
doc/api/domain.markdown Outdated
Copy link

Choose a reason for hiding this comment

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

It might help to mention why the master process exits with an error in this case. Unless readers are familiar with the cluster module, it's not crystal clear.

@misterdjules
Copy link

@jasnell Thank you for doing that!

I'm not a fan of having the first/only examples tied to using the cluster module. Not because the two don't go well together, but because it adds to the cognitive load when reading the documentation: one has to be familiar with the cluster module to understand the documentation about domains. I understand though that changing that is not in the scope of this PR. So please feel free to ignore my comments on this topic for now :)

Once the rest of my comments are addressed I'll take another look, but this already looks like a great improvement.

@jasnell
Copy link
Member Author

jasnell commented Jan 15, 2016

@misterdjules .. thanks for the comments! I'll update shortly

@estliberitas estliberitas force-pushed the master branch 2 times, most recently from 7da4fd4 to c7066fb Compare April 26, 2016 05:22
@jasnell jasnell closed this May 1, 2016
@leonardoadame leonardoadame mentioned this pull request May 16, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. domain Issues and PRs related to the domain subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jasnell @Qard @misterdjules @MylesBorins