Open timholy opened 4 years ago
Let's use this PR to hash out some kind of consensus format and then merge. I'd propose we leave the conversion of the remaining docstrings as a good first issue for newcomers (I'm bad about coming up with simple tasks for others to get their feet wet). See #153.
Merging #151 into master will not change coverage. The diff coverage is
n/a
.
@@ Coverage Diff @@
## master #151 +/- ##
=======================================
Coverage 91.65% 91.65%
=======================================
Files 9 9
Lines 1222 1222
=======================================
Hits 1120 1120
Misses 102 102
Impacted Files | Coverage Δ | |
---|---|---|
src/imfilter.jl | 90.81% <ø> (ø) |
:arrow_up: |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update 25bdade...54e7d3b. Read the comment docs.
The idea is to prepare for https://github.com/JuliaLang/julia/pull/34226, which will appear in Julia 1.5. This PR is essentially a demo of how I'd think of organizing the help: a relatively brief initial section that is somewhere between an explanation and a reminder, i.e., sufficient for someone who already knows what she is doing. Then the full details follow.