Skip to content

Commit

Permalink
Guidelines for documenting usntable contributions (#49296) (#49309)
Browse files Browse the repository at this point in the history
Encourage documentation of contributions that may be unstable but
require explicit admonition.
Also add review of "Writing Documentation" to contributors checklist
  • Loading branch information
Tokazama authored Apr 19, 2023
1 parent 2eea585 commit b664693
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ If you are already familiar with Julia itself, this blog post by Katharine Hyatt

* Review discussions on the [Julia Discourse forum](https://discourse.julialang.org).

* Review [Writing Documentation](https://github.com/JuliaLang/julia/blob/master/doc/src/manual/documentation.md#writing-documentation).

* For more detailed tips, read the [submission guide](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#submitting-contributions) below.

* Relax and have fun!
Expand Down Expand Up @@ -181,6 +183,15 @@ At the moment, this should always be done with the following `compat` admonition
This method was added in Julia 1.X.
```
#### Documenting unstable APIs
Some contributions are intended primarily for internal use or may be part of an API that is still in development. In addition to appropriate documentation, relevant code should be clearly annotated as unstable as follows:
```
!!! danger "Unstable"
This method is unstable and subject to change without notice.
```
### Contributing to core functionality or base libraries
*By contributing code to Julia, you are agreeing to release it under the [MIT License](https://github.com/JuliaLang/julia/tree/master/LICENSE.md).*
Expand Down

2 comments on commit b664693

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Executing the daily package evaluation, I will reply here when finished:

@nanosoldier runtests(isdaily = true)

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your package evaluation job has completed - possible new issues were detected.
A full report can be found here.

Please sign in to comment.