Skip to content
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

Load docstrings from markdown files #14

Merged
merged 1 commit into from
Oct 2, 2019
Merged

Conversation

tkf
Copy link
Member

@tkf tkf commented Oct 2, 2019

Since most of the code in this repo will be documentation, how about putting docstring in separated markdown files? It's easier to edit and review.

@codecov-io
Copy link

codecov-io commented Oct 2, 2019

Codecov Report

Merging #14 into master will increase coverage by 2.14%.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #14      +/-   ##
=======================================
+ Coverage   92.85%   95%   +2.14%     
=======================================
  Files           1     1              
  Lines          14    20       +6     
=======================================
+ Hits           13    19       +6     
  Misses          1     1
Impacted Files Coverage Δ
src/ConstructionBase.jl 95% <100%> (+2.14%) ⬆️

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 702347f...4034b67. Read the comment docs.

@jw3126
Copy link
Member

jw3126 commented Oct 2, 2019

Yeah these docstrings start becoming unwieldy moving them is a good idea!

@tkf tkf removed the DO NOT MERGE label Oct 2, 2019
@tkf tkf changed the title Use markdown files as docstring Load docstrings from markdown files Oct 2, 2019
@tkf
Copy link
Member Author

tkf commented Oct 2, 2019

OK. I did the same thing for setproperties. Please merge or approve.

@jw3126 jw3126 merged commit 9eb7316 into JuliaObjects:master Oct 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants