doc: explain path.format expected properties #5801
Conversation
mscdex
added
doc
|
Thanks, please wrap lines at 80 characters if that's not too much work. It could also be be nice to expand a little here. |
|
I'll fix the long line, thanks for pointing that out. I was going to expand further with more examples in a different PR fixing #5747. Would adding more examples in a separate PR be preferred? |
|
I think one PR is fine but @Trott is more experienced here than I. |
eversojk
force-pushed
the
doc-path-expected-properties
branch
from
d8fde07
to
8c469c2
Compare
|
Ok, I'll wait until he chimes in before adding the additional examples. |
|
One PR is fine as long as the changes are all relevant to the same issue. There can be multiple commits if necessary. |
|
One PR is fine in this case, but two is also fine, and since you already have it as two, maybe leave it as that. As this is your first commit (right?), it might be best to keep it small anyway so we can focus on process and not endless nits on grammar and style. |
|
LGTM. If you can squash the two commits down to one and force push, that would be great. If not, whoever lands this can do it. |
| If `pathObject` has all expected properties, the returned string will be a | ||
| concatenation of the `dir` property, the platform-dependent path separator, and | ||
| the `base` property. | ||
| If `pathObject` has the `dir` and `base` properties, the returned string will |
There was a problem hiding this comment.
Nit: Might be better as "has dir and base properties" (no "the").
doc: limit path.format line to 80 characters doc: path.format remove the
eversojk
force-pushed
the
doc-path-expected-properties
branch
from
b680849
to
c682329
Compare
|
Still LGTM. Nit: The body of the commit message should probably be a sentence explaining the change rather than the first line of the commits that we're squashed. |
Explain the expected properties in path.format Fixes: #5746 PR-URL: #5801 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
|
@benjamingr Thanks! Also thanks for your input @jasnell @Trott |
Explain the expected properties in path.format Fixes: #5746 PR-URL: #5801 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Explain the expected properties in path.format Fixes: #5746 PR-URL: #5801 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Explain the expected properties in path.format Fixes: #5746 PR-URL: #5801 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Explain the expected properties in path.format Fixes: #5746 PR-URL: #5801 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Pull Request check-list
Please make sure to review and check all of these items:
make -j8 test(UNIX) orvcbuild test nosign(Windows) pass withthis change (including linting)?
test (or a benchmark) included?
existing APIs, or introduces new ones)?
Affected core subsystem(s)
path
Description of change
explain path.format expected properties
fixes #5746