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

Update and extend the documentation of expm, logm and sqrtm #12432

Merged
merged 1 commit into from
Aug 12, 2015

Conversation

mfasi
Copy link
Contributor

@mfasi mfasi commented Aug 2, 2015

Documentation update originally in #12408, moved here after #11943 was merged.

@tkelman
Copy link
Contributor

tkelman commented Aug 2, 2015

I think docstrings actually need to change in helpdb.jl now, not in the rst. But please stand by for an announcement on that.

@mfasi
Copy link
Contributor Author

mfasi commented Aug 2, 2015

@tkelman OK, thank you. No problem, I just wanted to avoid having documentation and consistency together, as the latter seems to need some more work. Now that I can keep them separate I'm happy.

@tkelman
Copy link
Contributor

tkelman commented Aug 2, 2015

The docs for expm now live here -

julia/base/docs/helpdb.jl

Lines 10748 to 10755 in 7023fc3

doc"""
```rst
::
expm(A)
Compute the matrix exponential of ``A``.
```
"""

sqrtm and logm should live somewhere else in the file, but I believe it should be safe right now to move the docstrings to the location of those functions' source. You can run ./julia doc/genstdlib.jl to see what the generated rst docs should look like.

@kshyatt kshyatt added domain:docs This change adds or pertains to documentation domain:linear algebra Linear algebra labels Aug 2, 2015
@mfasi
Copy link
Contributor Author

mfasi commented Aug 3, 2015

@tkelman Maybe something's not working properly yet. By running ./julia doc/genstdlib.jl I get something like

INFO: no docs for Base.ndims
INFO: no docs for Base.size
INFO: no docs for Base.iseltype
INFO: no docs for Base.length
INFO: no docs for Base.eachindex
INFO: no docs for Base.Base.linearindexing
INFO: no docs for Base.countnz
INFO: no docs for Base.conj!
INFO: no docs for Base.stride
INFO: no docs for Base.strides
INFO: no docs for Base.ind2sub
...

and the .rst files are not changed.

EDIT: it seems that travis can generate the .rst, so it might be a local problem.

@tkelman
Copy link
Contributor

tkelman commented Aug 3, 2015

I think those warnings are normal, but the rst files should be changing. Not sure what's up there.

@mfasi mfasi force-pushed the matfun_doc branch 4 times, most recently from fb37ba4 to c4f8aea Compare August 4, 2015 12:37
@mfasi
Copy link
Contributor Author

mfasi commented Aug 5, 2015

@tkelman I figured out what I did wrong: each time you change something in base/docs/helpdb.jl, you have to recompile julia before running ./julia doc/genstdlib.jl. Anyway, the generated documentation looks fine, feel free to merge this PR.

StefanKarpinski added a commit that referenced this pull request Aug 12, 2015
Update and extend the documentation of expm, logm and sqrtm
@StefanKarpinski StefanKarpinski merged commit 7dd5e6a into JuliaLang:master Aug 12, 2015
@mfasi mfasi deleted the matfun_doc branch August 12, 2015 09:47
@ViralBShah
Copy link
Member

I think this deserves a mention in NEWS.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation domain:linear algebra Linear algebra
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants