Improve documentation of std.file.SpanMode (issue 8680) #5569
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
This clarifies the terminology used for describing the iteration order of dirEntries, as the current terminology has been found misleading.
|
Thanks for your pull request, @CyberShadow! Bugzilla references
|
|
Sorry, I missed an overload: #5571 |
wilzbach
reviewed
Jul 7, 2017
| mode = Whether the directory's sub-directories should be | ||
| iterated in depth-first port-order ($(LREF depth)), | ||
| depth-first pre-order ($(LREF breadth)), or not at all | ||
| ($(LREF shallow)). |
There was a problem hiding this comment.
Ddox doesn't seem to understand this: https://dlang.org/library-prerelease/std/file/dir_entries.html
I guess SpanMode.mode would work properly in Ddox?
There was a problem hiding this comment.
Then I can't use in with LREF.
Maybe there could be a LREF variant that links to the new hierarchical anchors, i.e. HLREF = <a href="#.$1">$(D $1)</a>, but... more macros...
wilzbach
added a commit
that referenced
this pull request
Jul 7, 2017
Update a missed dirEntries overload (fixup for #5569)
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.
This clarifies the terminology used for describing the iteration order of
dirEntries, as the current terminology has been found misleading.