From 4db419b7f689a656be6b5daf266a12ab446cbf9f Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Fri, 24 Jan 2020 09:11:58 +0100 Subject: [PATCH] Remove URLs with /latest and use correct, relative, (#34491) documenter links for the manual, fixes #34488. --- CONTRIBUTING.md | 6 +++--- README.md | 2 +- doc/README.md | 2 +- doc/src/manual/parallel-computing.md | 2 +- doc/src/manual/performance-tips.md | 2 +- doc/src/manual/style-guide.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f8e777ff4f3cb..e38d333291d15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ If you are already familiar with Julia itself, this blog post by Katharine Hyatt ## Learning Julia -[The learning page](https://julialang.org/learning) has a great list of resources for new and experienced users alike. [This tutorial video](https://www.youtube.com/watch?v=vWkgEddb4-A) is one recommended starting point, as is the "[Invitation to Julia](https://www.youtube.com/watch?v=gQ1y5NUD_RI)" workshop video from JuliaCon 2015 ([slide materials here](https://github.com/dpsanders/invitation_to_julia)). The [Julia documentation](https://docs.julialang.org/en/latest) covers the language and core library features, and is searchable. +[The learning page](https://julialang.org/learning) has a great list of resources for new and experienced users alike. [This tutorial video](https://www.youtube.com/watch?v=vWkgEddb4-A) is one recommended starting point, as is the "[Invitation to Julia](https://www.youtube.com/watch?v=gQ1y5NUD_RI)" workshop video from JuliaCon 2015 ([slide materials here](https://github.com/dpsanders/invitation_to_julia)). The [Julia documentation](https://docs.julialang.org) covers the language and core library features, and is searchable. ## Before filing an issue @@ -43,7 +43,7 @@ A useful bug report filed as a GitHub issue provides information about how to re - Try some simple debugging techniques to help isolate the problem. - Try running the code with the debug build of Julia with `make debug`, which produces the `usr/bin/julia-debug`. - Consider running `julia-debug` with a debugger such as `gdb` or `lldb`. Obtaining even a simple [backtrace](http://www.unknownroad.com/rtfm/gdbtut/gdbsegfault.html) is very useful. - - If Julia segfaults, try following [these debugging tips](https://docs.julialang.org/en/latest/devdocs/backtraces#Reporting-and-analyzing-crashes-(segfaults)-1) to help track down the specific origin of the bug. + - If Julia segfaults, try following [these debugging tips](https://docs.julialang.org/en/v1/devdocs/backtraces/) to help track down the specific origin of the bug. 2. If the problem is caused by a Julia package rather than core Julia, file a bug report with the relevant package author rather than here. @@ -86,7 +86,7 @@ There are never enough tests. Track [code coverage at Coveralls](https://coveral 2. Browse through the source files and find some untested functionality (highlighted in red) that you think you might be able to write a test for. -3. Write a test that exercises this functionality---you can add your test to one of the existing files, or start a new one, whichever seems most appropriate to you. If you're adding a new test file, make sure you include it in the list of tests in `test/choosetests.jl`. https://docs.julialang.org/en/latest/stdlib/Test/ may be helpful in explaining how the testing infrastructure works. +3. Write a test that exercises this functionality---you can add your test to one of the existing files, or start a new one, whichever seems most appropriate to you. If you're adding a new test file, make sure you include it in the list of tests in `test/choosetests.jl`. https://docs.julialang.org/en/v1/stdlib/Test/ may be helpful in explaining how the testing infrastructure works. 4. Run `make test-all` to rebuild Julia and run your new test(s). If you had to fix a bug or add functionality in `base`, this will ensure that your test passes and that you have not introduced extraneous whitespace. diff --git a/README.md b/README.md index ac4bc1e0f3fef..5a6388944656e 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ The Julia source code is organized as follows: ## Terminal, Editors and IDEs The Julia REPL is quite powerful. See the section in the manual on -[the Julia REPL](https://docs.julialang.org/en/latest/stdlib/REPL/) +[the Julia REPL](https://docs.julialang.org/en/v1/stdlib/REPL/) for more details. Support for editing Julia is available for many diff --git a/doc/README.md b/doc/README.md index c1541ddc7b747..be5426018084d 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,6 +1,6 @@ # Julia Documentation README -Julia's documentation is written in Markdown. A reference of all supported syntax can be found in the [manual](https://docs.julialang.org/en/latest/stdlib/Markdown/). All documentation can be found in the Markdown files in `doc/src/` and the docstrings in Julia source files in `base/`. +Julia's documentation is written in Markdown. A reference of all supported syntax can be found in the [manual](https://docs.julialang.org/en/v1/stdlib/Markdown/). All documentation can be found in the Markdown files in `doc/src/` and the docstrings in Julia source files in `base/` and `stdlib/`. ## Requirements diff --git a/doc/src/manual/parallel-computing.md b/doc/src/manual/parallel-computing.md index 1c99b3b8dcfa2..64ec05ea320c6 100644 --- a/doc/src/manual/parallel-computing.md +++ b/doc/src/manual/parallel-computing.md @@ -394,7 +394,7 @@ julia> acc[] When using multi-threading we have to be careful when using functions that are not [pure](https://en.wikipedia.org/wiki/Pure_function) as we might get a wrong answer. For instance functions that have their -[name ending with `!`](https://docs.julialang.org/en/latest/manual/style-guide/#Append-!-to-names-of-functions-that-modify-their-arguments-1) +[name ending with `!`](@ref bang-convention) by convention modify their arguments and thus are not pure. However, there are functions that have side effects and their name does not end with `!`. diff --git a/doc/src/manual/performance-tips.md b/doc/src/manual/performance-tips.md index 35f7460e79f73..c7d0e0ea13e96 100644 --- a/doc/src/manual/performance-tips.md +++ b/doc/src/manual/performance-tips.md @@ -1188,7 +1188,7 @@ Sometimes you can enable better optimization by promising certain program proper The common idiom of using 1:n to index into an AbstractArray is not safe if the Array uses unconventional indexing, and may cause a segmentation fault if bounds checking is turned off. Use `LinearIndices(x)` or `eachindex(x)` -instead (see also [offset-arrays](https://docs.julialang.org/en/latest/devdocs/offset-arrays/)). +instead (see also [Arrays with custom indices](@ref man-custom-indices)). !!! note While `@simd` needs to be placed directly in front of an innermost `for` loop, both `@inbounds` and `@fastmath` diff --git a/doc/src/manual/style-guide.md b/doc/src/manual/style-guide.md index e9d21a48f7c94..e2513bde013bf 100644 --- a/doc/src/manual/style-guide.md +++ b/doc/src/manual/style-guide.md @@ -86,7 +86,7 @@ One issue here is that if a function inherently requires integers, it might be b the caller to decide how non-integers should be converted (e.g. floor or ceiling). Another issue is that declaring more specific types leaves more "space" for future method definitions. -## Append `!` to names of functions that modify their arguments +## [Append `!` to names of functions that modify their arguments](@id bang-convention) Instead of: