You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In particular, it seems like Documenter takes the level-one heading to
define the page title. So the page titles were missing in the TOC before
this change.
Copy file name to clipboardExpand all lines: doc/src/devdocs/contributing/code-changes.md
+8-6Lines changed: 8 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,6 @@
1
-
### Contributing to core functionality or base libraries
1
+
# Code changes
2
+
3
+
## Contributing to core functionality or base libraries
2
4
3
5
*By contributing code to Julia, you are agreeing to release it under the [MIT License](https://github.com/JuliaLang/julia/tree/master/LICENSE.md).*
4
6
@@ -25,7 +27,7 @@ Add new code to Julia's base libraries as follows (this is the "basic" approach;
25
27
26
28
Build as usual, and do `make clean testall` to test your contribution. If your contribution includes changes to Makefiles or external dependencies, make sure you can build Julia from a clean tree using `git clean -fdx` or equivalent (be careful – this command will delete any files lying around that aren't checked into git).
27
29
28
-
####Running specific tests
30
+
### Running specific tests
29
31
30
32
There are `make` targets for running specific tests:
31
33
@@ -35,7 +37,7 @@ You can also use the `runtests.jl` script, e.g. to run `test/bitarray.jl` and `t
35
37
36
38
./usr/bin/julia test/runtests.jl bitarray math
37
39
38
-
####Modifying base more efficiently with Revise.jl
40
+
### Modifying base more efficiently with Revise.jl
39
41
40
42
[Revise](https://github.com/timholy/Revise.jl) is a package that
41
43
tracks changes in source files and automatically updates function
@@ -74,7 +76,7 @@ system image before running the corresponding test. This can be useful as a shor
74
76
on the command line (since tests aren't always designed to be run outside the
75
77
runtest harness).
76
78
77
-
###Contributing to the standard library
79
+
## Contributing to the standard library
78
80
79
81
The standard library (stdlib) packages are baked into the Julia system image.
80
82
When running the ordinary test workflow on the stdlib packages, the system image
@@ -92,11 +94,11 @@ not override the package.
92
94
93
95
Be sure to change the UUID value back before making the pull request.
94
96
95
-
####News-worthy changes
97
+
### News-worthy changes
96
98
97
99
For new functionality and other substantial changes, add a brief summary to `NEWS.md`. The news item should cross reference the pull request (PR) parenthetically, in the form `([#pr])`. To add the PR reference number, first create the PR, then push an additional commit updating `NEWS.md` with the PR reference number. We periodically run `./julia doc/NEWS-update.jl` from the julia directory to update the cross-reference links, but this should not be done in a typical PR in order to avoid conflicting commits.
98
100
99
-
####Annotations for new features, deprecations and behavior changes
101
+
### Annotations for new features, deprecations and behavior changes
100
102
101
103
API additions and deprecations, and minor behavior changes are allowed in minor version releases.
102
104
For documented features that are part of the public API, a compatibility note should be added into
Copy file name to clipboardExpand all lines: doc/src/devdocs/contributing/documentation.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
###Improving documentation
1
+
# Improving documentation
2
2
3
3
*By contributing documentation to Julia, you are agreeing to release it under the [MIT License](https://github.com/JuliaLang/julia/tree/master/LICENSE.md).*
4
4
@@ -16,7 +16,7 @@ from Julia's root directory. This will rebuild the Julia system image, then inst
16
16
17
17
Below are outlined the three most common types of documentation changes and the steps required to perform them. Please note that the following instructions do not cover the full range of features provided by Documenter.jl. Refer to [Documenter's documentation](https://juliadocs.github.io/Documenter.jl/stable) if you encounter anything that is not covered by the sections below.
18
18
19
-
####Modifying files in `doc/src/`
19
+
## Modifying files in `doc/src/`
20
20
21
21
Most of the source text for the Julia Manual is located in `doc/src/`. To update or add new text to any one of the existing files the following steps should be followed:
22
22
@@ -33,7 +33,7 @@ To add a **new file** to `doc/src/` rather than updating a file replace step `1`
33
33
34
34
1. add the file to the appropriate subdirectory in `doc/src/` and also add the file path to the `PAGES` vector in `doc/make.jl`.
35
35
36
-
####Modifying an existing docstring in `base/`
36
+
## Modifying an existing docstring in `base/`
37
37
38
38
All docstrings are written inline above the methods or types they are associated with and can be found by clicking on the `source` link that appears below each docstring in the HTML file. The steps needed to make a change to an existing docstring are listed below:
39
39
@@ -43,7 +43,7 @@ All docstrings are written inline above the methods or types they are associated
43
43
4. check the output in `doc/_build/html/` to make sure the changes are correct;
44
44
5. commit your changes and open a pull request.
45
45
46
-
####Adding a new docstring to `base/`
46
+
## Adding a new docstring to `base/`
47
47
48
48
The steps required to add a new docstring are listed below:
49
49
@@ -71,7 +71,7 @@ The steps required to add a new docstring are listed below:
71
71
6. check the output in`doc/_build/html` to make sure the changes are correct;
72
72
7. commit your changes and open a pull request.
73
73
74
-
#### Doctests
74
+
## Doctests
75
75
76
76
Examples written within docstrings can be used as testcases known as "doctests" by annotating code blocks with `jldoctest`.
Copy file name to clipboardExpand all lines: doc/src/devdocs/contributing/git-workflow.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Git workflow recommendations
2
2
3
-
###Git Recommendations For Pull Requests
3
+
## Git Recommendations For Pull Requests
4
4
5
5
- Avoid working from the `master` branch of your fork. Create a new branch as it will make it easier to update your pull request if Julia's `master` changes.
6
6
- Try to [squash](https://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) together small commits that make repeated changes to the same section of code, so your pull request is easier to review. A reasonable number of separate well-factored commits is fine, especially for larger changes.
@@ -14,6 +14,6 @@
14
14
- To remove whitespace relative to the `master` branch, run
15
15
`git rebase --whitespace=fix master`.
16
16
17
-
####Git Recommendations For Pull Request Reviewers
17
+
### Git Recommendations For Pull Request Reviewers
18
18
19
19
- When merging, we generally like `squash+merge`. Unless it is the rare case of a PR with carefully staged individual commits that you want in the history separately, in which case `merge` is acceptable, but usually prefer `squash+merge`.
0 commit comments