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

Couple of small docs fixes #18784

Merged
merged 2 commits into from
Oct 6, 2016
Merged

Couple of small docs fixes #18784

merged 2 commits into from
Oct 6, 2016

Conversation

martinholters
Copy link
Member

...which where probably forgotten to commit in other PRs.

@martinholters
Copy link
Member Author

Would it make sense to have Travis/AppVeyor run julia doc/genstdlib.jl and verify that a) it does not error and b) the contents of doc/stdlib did not change?

@kshyatt kshyatt added the docs This change adds or pertains to documentation label Oct 4, 2016
@@ -3059,14 +3059,6 @@ Return `true` if `A` is a subset of or equal to `S`.
issubset

"""
stringmime(mime, x)
Copy link
Contributor

Choose a reason for hiding this comment

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

Was this copied out of helpdb and someone forgot to remove it?

Copy link
Member Author

Choose a reason for hiding this comment

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

Apparently as part of bc9b6ef (#18441), yes.

@@ -1545,7 +1565,7 @@ Internals
julia> M.f()
(1,2)

With @macroexpand the expression expands where @macroexpand appears in the code (module M). With macroexpand the expressions expands in the current module where the code was finally called. Note that when calling macroexpand or @macroexpand directly from the REPL, both of these contexts coincide, hence there is no difference.
With ``@macroexpand`` the expression expands where ``@macroexpand`` appears in the code (module ``M``\ ). With ``macroexpand`` the expressions expands in the current module where the code was finally called (REPL). Note that when calling ``macroexpand`` or ``@macroexpand`` directly from the REPL, both of these contexts coincide, hence there is no difference.
Copy link
Contributor

Choose a reason for hiding this comment

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

ref #18660 (comment) I think we should delete this (REPL) parenthetical both here and at the source, since it's confusing and not very general.

Copy link
Member Author

Choose a reason for hiding this comment

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

See my comment #18660 (comment) there.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated accordingly.

@tkelman
Copy link
Contributor

tkelman commented Oct 5, 2016

Yes we should do some sort of doc building on CI. Last time I tried I couldn't come up with something that didn't result in too frequently recompiling the system image. And the doc building mechanism will probably be changing soon.

@davidagold
Copy link
Contributor

I believe I need this PR in order to fix the issues Tony mentions here: #18484 (comment)

With `@macroexpand` the expression expands where `@macroexpand` appears in the code (module `M`).
With `macroexpand` the expressions expands in the current module where the code was finally called (REPL).
With `@macroexpand` the expression expands where `@macroexpand` appears in the code (module
`M` in the example). With `macroexpand` the expressions expands in the current module where
Copy link
Contributor

Choose a reason for hiding this comment

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

"expression expands", right?

Copy link
Member Author

Choose a reason for hiding this comment

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

I guess so. Anything else?

...which where probably forgotten to commit in other PRs.
@tkelman tkelman merged commit 4f08e6f into master Oct 6, 2016
@tkelman tkelman deleted the mh/docfixes branch October 6, 2016 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants