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

path, doc: Explain "expected properties" #5746

Closed
Trott opened this issue Mar 16, 2016 · 2 comments
Closed

path, doc: Explain "expected properties" #5746

Trott opened this issue Mar 16, 2016 · 2 comments
Labels
doc Issues and PRs related to the documentations. path Issues and PRs related to the path subsystem.

Comments

@Trott
Copy link
Member

Trott commented Mar 16, 2016

In the path.format() documentation, it refers to the "expected properties" of pathObject. Add a sentence or so explaining what those "expected properties" are or link to another part of the doc that explains such things.

Alternatively, change that sentence to specify the dir and base properties rather than "expected properties" since those are actually the only two that matter in the context of the sentence that says "expected properties".

This is a good first contribution for someone interested in getting familiar with the contribution process.
@Trott Trott added doc Issues and PRs related to the documentations. path Issues and PRs related to the path subsystem. good first issue Issues that are suitable for first-time contributors. labels Mar 16, 2016
@eversojk
Copy link
Contributor

I can take a look at this as well along with #5747.

@eversojk eversojk mentioned this issue Mar 19, 2016
Closed
3 tasks
@Trott
Copy link
Member Author

Trott commented Mar 21, 2016

We have a PR for this so I'll remove good first contribution so no one else tries to do it too!

@Trott Trott removed the good first issue Issues that are suitable for first-time contributors. label Mar 21, 2016
evanlucas pushed a commit that referenced this issue Mar 30, 2016
@eversojk @evanlucas
doc: explain path.format expected properties
93638e1 
Explain the expected properties in path.format

Fixes: #5746
PR-URL: #5801
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
MylesBorins pushed a commit that referenced this issue Mar 30, 2016
@eversojk
doc: explain path.format expected properties
c2514b5 
Explain the expected properties in path.format

Fixes: #5746
PR-URL: #5801
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
MylesBorins pushed a commit that referenced this issue Mar 30, 2016
@eversojk
doc: explain path.format expected properties
79d26ae 
Explain the expected properties in path.format

Fixes: #5746
PR-URL: #5801
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
evanlucas pushed a commit that referenced this issue Mar 31, 2016
@eversojk @evanlucas
doc: explain path.format expected properties
5676a35 
Explain the expected properties in path.format

Fixes: #5746
PR-URL: #5801
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. path Issues and PRs related to the path subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: explain path.format expected properties eversojk/node
2 participants
@Trott @eversojk