-
-
Notifications
You must be signed in to change notification settings - Fork 693
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.
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
Ehance ddoc for std.array.split. #2817
Conversation
An array containing the divided parts of $(D r). | ||
|
||
See_Also: | ||
$(XREF algorithm, splitter) for the lazy version of this operator. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Function, not operator
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That was in the original text and I overlooked it. Updated.
Can we avoid using single characters for the range? It's even easier to read the docs if we use |
Or use |
Changing 'r' to 'range' is fine with me. We ought to be consistent about it, though, since 'r' is used in a lot of places. |
Could you squash the first two commits together? (the ones introducing and then changing operator->function) |
Sure, if you give me some hints on how to do it. |
Oh, nevermind. I see "squash" is a real thing. I'll figure this out. |
Ah sorry, I haven't realized you're new to Git! Typically you would use the git interactive mode to edit the commits. For example:
And then you usually get a
You can change the second In your case you can simply use a fixup. |
So after googling how to squash and how to move around the editor in git-bash (which appears to be vim), I think I've managed it somehow. |
I've been happily using git for a few years now. Just pushing and pulling for the most part. This is my second PR ever. |
Good job! Done it without my help. :P |
Auto-merge toggled on |
This will work a lot better now that I've approved him on the autotester. |
Ehance ddoc for std.array.split.
lol! I didn't see the status anywhere so I just replace the typical autotester URL with /2817 and it worked. Perhaps there should be a message here in the status bar "Author not approved for auto-testing" or something. :) |
This started with fixing a simple typo, but I decided to go ahead and go all out. If I'm on the right track with this, I'll do more.
I've added an extra paragraph, appropriate DDOC tags (Examples, Params, Returns), and changed the template type parameters to match the type parameters for std.algorithm.splitter. I also renamed the delimiter parameter to 'sep' to match std.array.join which follows this (std.algorthim.splitter calls it 's' instead).
I'm not sure about the description of the returned array. Should it be called an 'array of ranges'?
Finally, I think the version of the template that has the 'alias isTerminator' needs to be documented separately, but I haven't figured out yet what that template alias is doing.