Documentation: update the docs strings #126
Merged
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
b4ldr
force-pushed
the
fix_docstrings
branch
from
69f1589
to
b3eb48f
Compare
b4ldr
force-pushed
the
fix_docstrings
branch
from
b3eb48f
to
7c2cea2
Compare
ekohl
requested changes
Feb 17, 2023
b4ldr
force-pushed
the
fix_docstrings
branch
from
7c2cea2
to
e651b37
Compare
ekohl
reviewed
Feb 17, 2023
There was a problem hiding this comment.
You can even consider stricter types, like Stdlib::IP::Address::Nosubnet and Stdlib::Fqdn for return types, but this is already an improvement.
It does look like the tests uncovered some issues though, so it looks like return_type does validate the type as well. Which I'd consider a nice bonus :)
b4ldr
force-pushed
the
fix_docstrings
branch
from
e651b37
to
6883561
Compare
b4ldr
force-pushed
the
fix_docstrings
branch
5 times, most recently
from
6d5058a
to
3ca9600
Compare
Also change the signature of the functions to make use of optional_block_param We also improve the type validation which requires adding a dependency on stdlib
b4ldr
force-pushed
the
fix_docstrings
branch
from
3ca9600
to
463dbf1
Compare
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.
Also change the signature of the functions to make use of optional_block_param