Skip to content

Commit

Permalink
minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
RLKRo committed Oct 10, 2023
1 parent d4b37c7 commit 49a9647
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,18 +69,23 @@ However, this behavior is likely to be changed in the future.

#### Documentation links

In your tutprials, you can use special expanding directives in markdown cells.
In your tutorials, you can use special expanding directives in markdown cells.
They can help shorten the comments and avoid boilerplate code.
The documentation links generated by the directives are always relative and verified during build.
The documentation links generated by the directives are always relative
to the local documentation and verified during build.

- `%pip install {}`
This directive generates dependency installation cell, adds a comment and sets up "quiet" flag.
E.g. it should be used in tutorials, like this: `# %pip install dff[...]`.
- `%pip install {args}`
This directive generates dependency installation cell, adds a comment and sets up "quiet" flag.

It should be used in tutorials, like this: `# %pip install dff[...]`.
- `%doclink({args})`
This directive generates a documentation link. It supports 2 or three arguments and the generated link will look like: `ARG1/ARG2#ARG3`.
NB! First argument can be either `api` for DFF codebase, `tutorial` for tutorials or `guide` for user guides.
This directive generates a documentation link. It supports 2 or three arguments and the generated link will look like: `ARG1/ARG2#ARG3`.

The first argument can be either `api` for DFF codebase, `tutorial` for tutorials or `guide` for user guides.
- `%mddoclink({args})`
This directive is a shortcut for `%doclink` that generates a markdown format link instead, so that the output will be similar to `[ARG2](%doclink(ARG1,ARG2))` or `[ARG3](%doclink(ARG1,ARG2,ARG3))`.
This directive is a shortcut for `%doclink` that generates a markdown format link instead.

The generated link will be either `[ARG2](%doclink(ARG1,ARG2))` or `[ARG3](%doclink(ARG1,ARG2,ARG3))`.

### Style
For style supporting we propose `black`, which is a PEP 8 compliant opinionated formatter.
Expand Down

0 comments on commit 49a9647

Please sign in to comment.