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 #66

Closed
dlfivefifty opened this issue Dec 24, 2018 · 7 comments
Closed

Add documentation #66

dlfivefifty opened this issue Dec 24, 2018 · 7 comments

Comments

@dlfivefifty
Copy link
Member

help?> gaussjacobi
search: gaussjacobi

  No documentation found.

  FastGaussQuadrature.gaussjacobi is a Function.

  # 2 methods for generic function "gaussjacobi":
  [1] gaussjacobi(n::Integer, a::Float64, b::Float64) in FastGaussQuadrature at /Users/solver/.julia/packages/FastGaussQuadrature/G3Izs/src/gaussjacobi.jl:7
  [2] gaussjacobi(n::Number, a::Number, b::Number) in FastGaussQuadrature at /Users/solver/.julia/packages/FastGaussQuadrature/G3Izs/src/gaussjacobi.jl:1
@hyrodium
Copy link
Collaborator

hyrodium commented Jan 6, 2021

Can I make a document with Documenter.jl?

@dlfivefifty
Copy link
Member Author

To add help documentation you just add a string before the function definition: if in a file I write

# foo.jl
"""
foo(x) does nothing
"""
foo(x) = nothing

Then I get:

help?> foo
search: foo floor pointer_from_objref OverflowError RoundFromZero unsafe_copyto!

  foo(x) does nothing

@hyrodium
Copy link
Collaborator

hyrodium commented Jan 6, 2021

Ah, thanks, I know that.

I was planning to add jldoctest for clarity. To check the tests, we need Documenter.jl. I thought this is a goot oppotunity to add more documents, but my concern was that adding Documenter.jl could be bigger change.

@dlfivefifty
Copy link
Member Author

I strongly support adding Documenter.jl so will happily help

@hyrodium
Copy link
Collaborator

hyrodium commented Jan 6, 2021

Okay, I'll make a pull request!

@hyrodium
Copy link
Collaborator

The github pages works fine, so I'll close this issue.
https://juliaapproximation.github.io/FastGaussQuadrature.jl/dev/

@dlfivefifty
Copy link
Member Author

Awesome!! Thank so much for this

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

No branches or pull requests

2 participants