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

WIP: Manual Fixes. JuliaCon 2016 Edition #17064

Merged
merged 9 commits into from
Jun 29, 2016
Merged

Conversation

omus
Copy link
Member

@omus omus commented Jun 22, 2016

I've been re-reading the manual to discover any new features I may have missed over the last year. During my reading so far I've found some issues:

  1. "Elementary Functions" section seemed very out of place. Mainly the problem is that it breaks up two sections that both talked about rounding
  2. The "Byte Array Literals" section contained a sentence talking about non-standard string literals conventions. I've moved it to a more appropriate area
  3. Found a trivial typo in the "Version Number Literals" section

omus added 3 commits June 22, 2016 10:43
The original location of the "Elementary Function" section broke the
flow between "Numerical Conversions" about round and the next section:
"Rounding Functions".

Additionally moved the "Elementary Function" section to be a subsection
of "Numeric Comparisons".
@ivarne ivarne added docs This change adds or pertains to documentation backport pending 0.4 labels Jun 22, 2016
@omus
Copy link
Member Author

omus commented Jun 22, 2016

I noticed inconsistency in how the manual refers to language. Sometimes it is referred to "Julia" and sometimes "julia". I've updated the manual (and one place in the REPL help) such that when referring to Julia is always "Julia".

Also, the "Elementary Function" commit (d1cf43c) shouldn't be backported as it that is a 0.5 feature.

omus added 2 commits June 22, 2016 22:43
The manual would sometimes refer to the language as either "Julia" or
"julia". This commit changes references to the Julia language as "Julia"
and any reference to the command line program as `julia`.
@@ -860,7 +860,7 @@ If ``io`` is not specified, ``host`` and ``port`` are used to connect.
For example, a cluster manager may launch a single worker per node, and use that to launch
additional workers. ``count`` with an integer value ``n`` will launch a total of ``n`` workers,
while a value of ``:auto`` will launch as many workers as cores on that machine.
``exename`` is the name of the julia executable including the full path.
``exename`` is the name of the Julia executable including the full path.
Copy link
Contributor

Choose a reason for hiding this comment

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

this might be better as quoted lowercase

Copy link
Member Author

@omus omus Jun 23, 2016

Choose a reason for hiding this comment

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

I was thinking that "Julia" would refer the the language while "julia" refers to the command-line program. Does that seem sensible?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, exactly. Probably makes sense to also put julia in backticks.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed. "julia executable" is pretty clearly the latter.

Copy link
Contributor

Choose a reason for hiding this comment

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

not yet addressed here

omus added 3 commits June 25, 2016 19:32
Also prepended "see" to the references and fixed a triple space after
a period.
@kshyatt
Copy link
Contributor

kshyatt commented Jun 28, 2016

AV restarted. @tkelman @StefanKarpinski do the latest changes here look ok?

@omus
Copy link
Member Author

omus commented Jun 28, 2016

Feel free to merge this whenever. I have a couple more corrections to add but I can always make another PR.

"Julia" refers to the language while "`julia`" (lowercase in backticks)
specifically refers to the executable.
@tkelman tkelman merged commit 9a1ee22 into JuliaLang:master Jun 29, 2016
@omus omus deleted the doc-fixes branch June 29, 2016 21:56
tkelman pushed a commit that referenced this pull request Sep 13, 2016
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.

5 participants