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

Convert Ac_ldiv_B etc. docs to Markdown #13108

Merged
merged 2 commits into from
Sep 13, 2015

Conversation

dpsanders
Copy link
Contributor

Convert the docs for the functions Ac_ldiv_B etc. to Markdown, eliminating the use of :sup: in helpdb.jl. #13047

This also homogenizes the signatures used in the docs for this set of functions.

Note that documentation for A_ldiv_B! is missing. I would add it, if I knew what this function does... (I guess it's A := A / B ?

@dpsanders
Copy link
Contributor Author

Docs also missing for A_mul_Bc! etc.

@yuyichao
Copy link
Contributor

The rendered html doesn't look too bad but this breaks make -C doc latexpdf again.

@jakebolewski
Copy link
Member

Is this because of the unicode superscripts?

@dpsanders
Copy link
Contributor Author

Ouch. What can I do about that?

@yuyichao
Copy link
Contributor

@jakebolewski Yes

@dpsanders Not sure. I think there's a commit/PR that fixes latexpdf recently but I'm having a hard time finding it.

@yuyichao
Copy link
Contributor

Find it 8dfdeaf

Do something like that then?

@dpsanders
Copy link
Contributor Author

Thanks @yuyichao -- now done. It's not exactly pretty in the PDF, but it's functional... (An alternative would be to use latex, $...$, instead of ..., in the docstrings, but that seems to be out of style.)

@yuyichao
Copy link
Contributor

I was actually going to suggest using math mode instead of code quote since these are more mathematically expressions rather than julia code.

@jakebolewski
Copy link
Member

It looks ok. If we transition to Markdown there is a good chance we will lose the fancy latex -> pdf output Sphinx offers anyway.

jakebolewski added a commit that referenced this pull request Sep 13, 2015
Convert Ac_ldiv_B etc. docs to Markdown
@jakebolewski jakebolewski merged commit 3a457ae into JuliaLang:master Sep 13, 2015
@dpsanders
Copy link
Contributor Author

I was just about to put up the version with inline Latex. Shall I make a new PR?

@dpsanders
Copy link
Contributor Author

(It does look better!)

@jakebolewski
Copy link
Member

sure

On Sun, Sep 13, 2015 at 6:13 PM, David P. Sanders [email protected]
wrote:

(It does look better!)


Reply to this email directly or view it on GitHub
#13108 (comment).

tkelman pushed a commit that referenced this pull request Sep 14, 2015
@tkelman
Copy link
Contributor

tkelman commented Sep 16, 2015

backported in #13107

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