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

Add documentation for StructuralContext to README #300

Merged
merged 2 commits into from
Jan 10, 2020

Conversation

TotalVerb
Copy link
Collaborator

Partially address #298 (still need docs for Serialization, but I only had time to write these so far).

I apologize for the lack of documentation when I implemented these features — it had been on my TODO list but slipped from the mind. I will make another PR with docs and examples for Serialization soon.

@codecov
Copy link

codecov bot commented Jan 6, 2020

Codecov Report

Merging #300 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #300      +/-   ##
==========================================
+ Coverage    98.2%   98.21%   +<.01%     
==========================================
  Files           8        8              
  Lines         390      392       +2     
==========================================
+ Hits          383      385       +2     
  Misses          7        7
Impacted Files Coverage Δ
src/Parser.jl 99.01% <0%> (ø) ⬆️

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 8f53dc0...5bb2c77. Read the comment docs.

@twavv
Copy link

twavv commented Jan 7, 2020

This looks awesome! Thank you for doing this!

It might be worth investing in setting up proper docs (à la Documenter.jl) because it might make the readme a bit bloated (definitely something that could be punted down the road though).

@TotalVerb TotalVerb merged commit f9922e4 into master Jan 10, 2020
@TotalVerb TotalVerb deleted the fw/structuralcontextdoc branch January 10, 2020 01:43
@TotalVerb
Copy link
Collaborator Author

Indeed, I agree that proper docs would be the right solution! In general, there is a lot of work that could be done to modernize this package (most of it was written back in the Julia 0.3/0.4 days), and adhering to new conventions is one thing we have been lagging on. But I guess it is better to have the documentation somewhere first.

We will keep #298 open until we have docs for Serialization too, which is perhaps actually even more important.

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.

2 participants