Add Diagram constructors to the public API explicitly
#13
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 ensures the docstring attached to the constructor can be included in the documentation. This constructor mostly exists to provide a more straightforward API that specifies the `type` first and the `specification` second, to accomodate for the order of the fields in the `Diagram` type. But both orders are technically okay.
Instead of duplicating the docstrings and signatures for the constructors of the `Diagram` type in its docstring, the constructors should be added to the API themselves.
Codecov Report
@@ Coverage Diff @@
## development #13 +/- ##
=============================================
Coverage 100.00% 100.00%
=============================================
Files 2 2
Lines 91 92 +1
=============================================
+ Hits 91 92 +1
Continue to review full report at Codecov.
|
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.
#12 duplicated the docstrings for the
Diagramconstructors in the docstring of theDiagramtype. Instead, the methods should have been explicitly added to the API documentation to include their docstrings directly without duplication.