Best Practices for reporting bugs or suggesting improvements to Julia Docs

General Usage
1

What’s the best way to

  1. Report possible typos or other technical errors in Julia Documentation, or
  2. Discuss potential improvements to the documentation, beyond minor typos?

For example, in the documentation for the sin function, I am expecting the See also link to sind to be clickable, but it’s not. Where should I bring that up? And where should we discuss more substantial issues related to the documentation?

Screen Shot 2022-04-27 at 9.55.43 AM
Screen Shot 2022-04-27 at 9.55.43 AM1554×448 23.3 KB

2

You may notice there is a “source” button on the lower right there, which takes you directly to the line. You can even change this in the github editor right there (though be aware of trailing spaces!). Someone seems to have added the right [] block, but seems to be missing the following “(@ref)” tag?

2 Likes