-
Notifications
You must be signed in to change notification settings - Fork 143
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
rewrite the module docstring #985
Conversation
Codecov Report
@@ Coverage Diff @@
## jc/houseclean #985 +/- ##
==============================================
Coverage 87.72% 87.72%
==============================================
Files 8 8
Lines 823 823
==============================================
Hits 722 722
Misses 101 101
Continue to review full report at Codecov.
|
If we're removing the API summary, perhaps we should make sure that all listed |
This seems to be a 1.0 milestone. I plan to have an issue to track all the exported symbols and add necessary docstrings and demo page before 1.0 release. (#986) |
src/Images.jl
Outdated
The purpose of this package is to have an out-of-box experiences for most of the stable | ||
functionalities. This means when you do `using Images`, you load a lot of packages that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The purpose of this package is to have an out-of-box experiences for most of the stable | |
functionalities. This means when you do `using Images`, you load a lot of packages that | |
Images provides an out-of-box toolkit for image processing. | |
This means when you do `using Images`, you load a lot of packages that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for most of the stable functionalities.
I do have some concerns with this. I'll write up a new issue to explain it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See simonster/Reexport.jl#37. This is why I think we can't expect Images to provide up-to-date functionalities if we want to follow the semver strictly. We have abused it a lot but I think we need to be more cautious on this after v1.0
Co-authored-by: Tim Holy <[email protected]>
I deliberately separate this into a new PR so we don't get lost in the lengthy discussions in #971
closes #982