Skip to content

Commit

Permalink
Fix mistakes I overlooked
Browse files Browse the repository at this point in the history
  • Loading branch information
rodrigogiraoserrao committed Sep 20, 2024
1 parent 4d3f2c6 commit 6a2b4bc
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/development/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,13 +244,13 @@ To add a code block with code to be run in a shell with tabs for Python and Rust

#### Adding a code block

The snippets for Python and Rust code blocks are in the `docs/assets/src/python/` and `docs/assets/src/rust/` directories, respectively. To add a code snippet with Python or Rust code to a `.md` page, use the following format:
The snippets for Python and Rust code blocks are in the `docs/source/src/python/` and `docs/source/src/rust/` directories, respectively. To add a code snippet with Python or Rust code to a `.md` page, use the following format:

```
{{code_block('user-guide/io/cloud-storage','read_parquet',['read_parquet','read_csv'])}}
```

- The first argument is a path to either or both files called `docs/assets/src/python/user-guide/io/cloud-storage.py` and `docs/assets/src/rust/user-guide/io/cloud-storage.rs`.
- The first argument is a path to either or both files called `docs/source/src/python/user-guide/io/cloud-storage.py` and `docs/source/src/rust/user-guide/io/cloud-storage.rs`.
- The second argument is the name given at the start and end of each snippet in the `.py` or `.rs` file
- The third argument is a list of links to functions in the API docs. For each element of the list there must be a corresponding entry in `docs/source/_build/API_REFERENCE_LINKS.yml`

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ theme:
- navigation.footer
- navigation.indexes
- content.tabs.link
- content.code.copy
icon:
repo: fontawesome/brands/github

Expand Down

0 comments on commit 6a2b4bc

Please sign in to comment.