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

updated deprecated makedocs call: format; clean build dir; aligned code #167

Merged
merged 24 commits into from
Aug 13, 2019

Conversation

PaulXiCao
Copy link
Contributor

@PaulXiCao PaulXiCao commented Jun 17, 2019

  • major change: updated makedoc call. format = :html is deprecated.
  • minor
    • cleaning build dir by default is useful
    • aligned code

PS: this is in reference to issue #159 .

docs/make.jl Outdated Show resolved Hide resolved
@simonbyrne
Copy link
Member

Thanks @PaulXiCao. A few points:

  1. I think this information would be better incorporated into the docstrings. These could then be grouped into headings as you've done here.
  2. Whether there is a BigFloat implementation is really an implementation detail, i.e. you can write something like:
## Implementation details

- `Float32`/`Float64`: C standard math library (libm)
- `BigFloat`: [MPFR](https://www.mpfr.org/)

@PaulXiCao
Copy link
Contributor Author

@simonbyrne I cannot find a good workflow. The documenter.jl does not use my uncommited docstrings. Do you know any way?

@simonbyrne
Copy link
Member

Change to the docs directory, start julia with julia --project, then do ]dev ..

@PaulXiCao
Copy link
Contributor Author

@simonbyrne could you give a short feedback on my commits?
I have done the following for all functions in erf.jl and ellip.jl

  • added documentation
  • cleaned the source code
  • added tests for every possible case (data types and each piecewise definition)

My questions

  1. Any feedback? Would you like something done differently?
  2. If I do the same for other files would you pull it at some point?
  3. Should I split my work into different merge requests or just keep pushing to this one?

@PaulXiCao PaulXiCao closed this Aug 12, 2019
@PaulXiCao
Copy link
Contributor Author

Closed by mistake... facepalm

@PaulXiCao PaulXiCao reopened this Aug 12, 2019
Copy link
Member

@simonbyrne simonbyrne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this looks really good!

docs/src/functions_overview.md Outdated Show resolved Hide resolved
@simonbyrne simonbyrne merged commit 186b6c7 into JuliaMath:master Aug 13, 2019
@simonbyrne
Copy link
Member

Looks much better, thanks!

@PaulXiCao PaulXiCao deleted the doc-makefile branch August 14, 2019 17:03
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.

None yet

3 participants