Updated Pselect's help to hopefully be clearer and more comprehensive. #3158
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
cianoc
changed the title
mossheim
suggested changes
Sep 3, 2017
HelpSource/Classes/Pselect.schelp
Outdated
|
|
||
| Values from the source pattern will be passed to strong::func::. Pselect will only return that value if the strong::func:: returns true. | ||
|
|
||
| This is the pattern libraries equivalent of link::Classes/Collection#-select#select::. |
HelpSource/Classes/Pselect.schelp
Outdated
| @@ -1,19 +1,23 @@ | |||
| class:: Pselect | |||
| summary:: Select values from a pattern | |||
| summary:: Filters values from return by a source pattern. | |||
There was a problem hiding this comment.
-> Filters values returned by a ...
mossheim
approved these changes
Sep 3, 2017
LFSaw
requested changes
Sep 3, 2017
|
@LFSaw those two functions aren't private, so I don't think that would be the right thing to do. |
|
It would be god to have a different tag for methods that aren't private but which we want to hide.
|
|
I think hide would be the wrong tag, as really we want this to appear as inherited instance methods, even though they've been overloaded. So I guess what you want is a way of tagging this as a method belonging to Pattern. By which I mean it's totally fine to use these methods, but it's better that people read about them in the context of Pattern, than here. |
LFSaw
approved these changes
Sep 3, 2017
|
since we agree on the values of these but start to talk about higher-level decisions, I merged. |
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.
Just general rewrites, plus the new method wasn't properly documented for Pselect.