documentation strings for set theory functions #76310
Closed
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
The set theory functions are not self-explanatory unless one has taken a course of mathematics or two, hence some documentation is warranted. Documentation was added for: - intersect - difference - symmetric_difference - union Signed-off-by: Katze <katze@inwx.de>
benaryorg
force-pushed
the
set_theory_docstrings
branch
from
b241434
to
bc72265
Compare
ansibot
added
affects_2.13
core_review
jborean93
removed
the
needs_triage
|
I recommend you have a look at this PR in flight that is implementing the new way to document filter plugins #74963 (see the |
ansibot
added
the
stale_ci
|
Thanks @benaryorg for the Ansible docs suggestion. With the new feature mentioned in the prior comment, we now have this documented in a new way via #77801. Closing this PR but thanks again for helping with the docs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
SUMMARY
The set theory functions are not self-explanatory unless one has taken a course of mathematics or two, hence some documentation is warranted.
Rationale being that I was reading a StackOverflow Answer pertaining to those exact functions and those did link to the code which, without further description is kind of hard to grasp for people not too acquainted with set theory.
For instance the Rust documentation on set functions provides a short description as well as examples, the latter being used as unit tests, which directly conveys to the user what behavior to expect from the invocation.
Documentation was added for:
ISSUE TYPE
COMPONENT NAME
filter/mathstuff