first pass at adding docstrings #98
Conversation
Codecov Report
@@ Coverage Diff @@
## master #98 +/- ##
=======================================
Coverage 94.11% 94.11%
=======================================
Files 1 1
Lines 374 374
=======================================
Hits 352 352
Misses 22 22
Continue to review full report at Codecov.
|
|
It would be best to propose the logo change at JuliaCollections/Roadmap#2 to get feedback first. |
|
@ararslan oh it's just a placeholder, they can chuck it away and run a competition if they want to! |
|
I still recommend posting it at the roadmap issue so it's more visible. It just might become the org logo. 😉 |
There was a problem hiding this comment.
Wow, thanks!
A few things:
- The
builddirectory is generated by Documenter when running make.jl so it shouldn't be committed here - Indentation in make.jl needs a fixup
- You have an extra blank line at the end of all your code blocks that can be removed
Otherwise great!
|
docs/build is added to the gitignore but it still has to be unstaged from the commit. You can do that using |
|
@ararslan thanks! I'm not a git-person... 😀 |
| # Index | ||
|
|
||
| ```@index | ||
| ``` |
There was a problem hiding this comment.
Did you mean for this to be empty?
There was a problem hiding this comment.
I think if it's empty it defaults to doing everything...
There was a problem hiding this comment.
Oh, okay. I'm not so good with Documenter, I just wanted to make sure. 🙂
|
Needs the new logo... :) |
|
The source branch was removed but this is still mergeable. I'll replace the logo myself and do a manual command-line merge. Hopefully I don't mess things up! |
|
Hmm apparently that is not possible. I'll try merging using the online interface and modifying the logo after. |
I had a go at adding docstrings to
src/Iterators.jl, since it's always nice to have some syntax info on hand. I also added adocs/directory, which can be used as you migrate to using Documenter.jl (although the entire process is more involved, with thegh-pagesbranch and Travis keys stuff...Logo.png is just a placeholder...