better docs: os #10492
Merged
better docs: os #10492
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Araq
reviewed
Jan 30, 2019
| ## # a/b/ | ||
| ## # a/b/c | ||
| ## | ||
| ## for p in g.parentDirs(inclusive=false): |
There was a problem hiding this comment.
I don't understand how this shows what inclusive means. And it should have been named fullPaths?
There was a problem hiding this comment.
i prefer this:
runnableExamples:
import sequtils
doAssert toSeq(parentDirs("a/b/c.nim", inclusive = true)) == @["a/b/c.nim", "a/b", "a"]- more compact
- makes clear behavior
inclusive=trueis to include the original path regardless it looks like a file or not (since it's a string-only operation (as opposed to file-system), it doesn't make a difference)
Araq
reviewed
Jan 30, 2019
|
my only concern is the doc links eg which are ugly when browsing (or writing!) source code, are not DRY, and add tehnical debt (and risk of breakage when signature proc changes) see nim-lang/RFCs#125 which would eliminate this issue |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.