JuliaLang / JuliaDoc

28 stars 26 forks source link

Explain first use of ÷ in the manual #25

Closed mark-summerfield closed 7 years ago

mark-summerfield commented 7 years ago

In http://docs.julialang.org/en/latest/manual/strings.html it shows this example: julia> str[end÷2] ' ': ASCII/Unicode U+0020 (category Zs: Separator, space)

But the meaning of the '÷' symbol is not explained. I'm guessing that it is a division operator but then why not use '/' ? So I think some explanation is appropriate.

yuyichao commented 7 years ago

The search is pretty bad but it is explained.

http://docs.julialang.org/en/latest/stdlib/math.html#Base.div

timholy commented 7 years ago

If one person is willing to go to the effort to report this (which takes more effort than doing nothing), I suspect we should assume that others may be confused, too. On that principle, I'd like to propose that we reopen this.

There's a difference between having a manual that experienced programmers can understand and one that's suitable for a wide audience. I think we've done really well in putting together a great manual. But we're all software developers, and I don't doubt that a first-class "documentation writer" (someone who does this for a living) would see numerous weaknesses in what we have now---something truly professional requires skills that are their own kind of expertise. As we move towards 1.0, I think we need to pay attention to this kind of stuff.

This seems interesting, but the mailing list seems dead so it's probably not relevant anymore.

simonbyrne commented 7 years ago

Agreed: we should reopen it on the main Julia repo though.

yuyichao commented 7 years ago

I agree this is confusing but I closed this because it's basically a dup of https://github.com/JuliaLang/JuliaDoc/issues/26