Skip to content

Commit d88369d

Browse files
authored
devdocs: contributing: fix headings (#58749)
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.
1 parent 45f5834 commit d88369d

File tree

6 files changed

+20
-19
lines changed

6 files changed

+20
-19
lines changed

doc/src/devdocs/contributing/code-changes.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff 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
24

35
*By contributing code to Julia, you are agreeing to release it under the [MIT License](https://github.com/JuliaLang/julia/tree/master/LICENSE.md).*
46

@@ -25,7 +27,7 @@ Add new code to Julia's base libraries as follows (this is the "basic" approach;
2527

2628
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).
2729

28-
#### Running specific tests
30+
### Running specific tests
2931

3032
There are `make` targets for running specific tests:
3133

@@ -35,7 +37,7 @@ You can also use the `runtests.jl` script, e.g. to run `test/bitarray.jl` and `t
3537

3638
./usr/bin/julia test/runtests.jl bitarray math
3739

38-
#### Modifying base more efficiently with Revise.jl
40+
### Modifying base more efficiently with Revise.jl
3941

4042
[Revise](https://github.com/timholy/Revise.jl) is a package that
4143
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
7476
on the command line (since tests aren't always designed to be run outside the
7577
runtest harness).
7678

77-
### Contributing to the standard library
79+
## Contributing to the standard library
7880

7981
The standard library (stdlib) packages are baked into the Julia system image.
8082
When running the ordinary test workflow on the stdlib packages, the system image
@@ -92,11 +94,11 @@ not override the package.
9294

9395
Be sure to change the UUID value back before making the pull request.
9496

95-
#### News-worthy changes
97+
### News-worthy changes
9698

9799
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.
98100

99-
#### Annotations for new features, deprecations and behavior changes
101+
### Annotations for new features, deprecations and behavior changes
100102

101103
API additions and deprecations, and minor behavior changes are allowed in minor version releases.
102104
For documented features that are part of the public API, a compatibility note should be added into

doc/src/devdocs/contributing/documentation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Improving documentation
1+
# Improving documentation
22

33
*By contributing documentation to Julia, you are agreeing to release it under the [MIT License](https://github.com/JuliaLang/julia/tree/master/LICENSE.md).*
44

@@ -16,7 +16,7 @@ from Julia's root directory. This will rebuild the Julia system image, then inst
1616
1717
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.
1818

19-
#### Modifying files in `doc/src/`
19+
## Modifying files in `doc/src/`
2020

2121
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:
2222

@@ -33,7 +33,7 @@ To add a **new file** to `doc/src/` rather than updating a file replace step `1`
3333

3434
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`.
3535

36-
#### Modifying an existing docstring in `base/`
36+
## Modifying an existing docstring in `base/`
3737

3838
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:
3939

@@ -43,7 +43,7 @@ All docstrings are written inline above the methods or types they are associated
4343
4. check the output in `doc/_build/html/` to make sure the changes are correct;
4444
5. commit your changes and open a pull request.
4545

46-
#### Adding a new docstring to `base/`
46+
## Adding a new docstring to `base/`
4747

4848
The steps required to add a new docstring are listed below:
4949

@@ -71,7 +71,7 @@ The steps required to add a new docstring are listed below:
7171
6. check the output in `doc/_build/html` to make sure the changes are correct;
7272
7. commit your changes and open a pull request.
7373

74-
#### Doctests
74+
## Doctests
7575

7676
Examples written within docstrings can be used as testcases known as "doctests" by annotating code blocks with `jldoctest`.
7777

doc/src/devdocs/contributing/formatting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
### Code Formatting Guidelines
1+
# Code Formatting Guidelines
22

3-
#### General Formatting Guidelines for Julia code contributions
3+
## General Formatting Guidelines for Julia code contributions
44

55
- Follow the latest dev version of [Julia Style Guide](https://docs.julialang.org/en/v1/manual/style-guide/).
66
- use whitespace to make the code more readable
@@ -11,7 +11,7 @@
1111
Unicode equivalents whenever possible
1212
- in docstrings refer to the language as "Julia" and the executable as "`julia`"
1313

14-
#### General Formatting Guidelines For C code contributions
14+
## General Formatting Guidelines For C code contributions
1515

1616
- 4 spaces per indentation level, no tabs
1717
- space between `if` and `(` (`if (x) ...`)

doc/src/devdocs/contributing/git-workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Git workflow recommendations
22

3-
### Git Recommendations For Pull Requests
3+
## Git Recommendations For Pull Requests
44

55
- 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.
66
- 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 @@
1414
- To remove whitespace relative to the `master` branch, run
1515
`git rebase --whitespace=fix master`.
1616

17-
#### Git Recommendations For Pull Request Reviewers
17+
### Git Recommendations For Pull Request Reviewers
1818

1919
- 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`.

doc/src/devdocs/contributing/patch-releases.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
2-
### Contributing to patch releases
1+
# Contributing to patch releases
32

43
The process of [creating a patch release](https://docs.julialang.org/en/v1/devdocs/build/distributing/#Point-releasing-101) is roughly as follows:
54

doc/src/devdocs/contributing/tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Writing tests
1+
# Writing tests
22

33
There are never enough tests. Track [code coverage at Codecov](https://codecov.io/github/JuliaLang/julia), and help improve it.
44

0 commit comments

Comments
 (0)