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

fix documentation #35

Merged
merged 5 commits into from
Dec 5, 2019
Merged

fix documentation #35

merged 5 commits into from
Dec 5, 2019

Conversation

cserteGT3
Copy link
Contributor

I missed throttle() from the documentation and tried to add it but encountered some issues, that I try to resolve in this PR.
Firstly, the documentation site is outdated. The last build was 11 month ago, neither releases and "latest" versions did not get their documentation.
I think the issue is, that the macros have doctests, which fail, because using Observables is missing.
I solved it with removing the jldoctest tag.
Secondly I wanted to add throttle() to the docs and thought that it would be easier to use @autodocs
Thirdly, I fixed a deprication warning in make.jl.

@codecov-io
Copy link

codecov-io commented May 24, 2019

Codecov Report

Merging #35 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@         Coverage Diff          @@
##           master   #35   +/-   ##
====================================
  Coverage      75%   75%           
====================================
  Files           5     5           
  Lines         148   148           
====================================
  Hits          111   111           
  Misses         37    37
Impacted Files Coverage Δ
src/macros.jl 82.35% <ø> (ø) ⬆️
src/time.jl 77.77% <ø> (ø) ⬆️
src/Observables.jl 71.23% <ø> (ø) ⬆️

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 77e984f...14101bd. Read the comment docs.

@cserteGT3
Copy link
Contributor Author

I just noticed #27 and the :html deprication was introduced in Documenter v0.21.0.
(I used Documenter v0.22.4)

@SimonDanisch
Copy link
Member

@shashi I'd say this is great and we should merge it?

@asinghvi17
Copy link
Contributor

Bump

@SimonDanisch SimonDanisch merged commit b7b20df into JuliaGizmos:master Dec 5, 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.

4 participants