Improve docstrings and remove implicit imports #227
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #227 +/- ##
=======================================
Coverage 78.17% 78.17%
=======================================
Files 9 9
Lines 362 362
=======================================
Hits 283 283
Misses 79 79 ☔ View full report in Codecov by Sentry. |
This properly fixes the issue with inner constructor docstrings not being displayed in the docs. Previously they were copied into the main `Socket`/`Message` type docstrings, but with `@doc` they're now recognized. Also added compat warnings for deprecated socket types.
Detected by ExplicitImports.jl.
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.
The bulk of the code removes the duplicate docstrings I added in #216 and properly assigns them using
@docso we can use them in the docs. I also took the opportunity to remove some implicit imports found by ExplicitImports.jl.