Skip to content

Commit 370e770

Browse files
authored
Fix heading levels of subsections of Code standards (#2393)
<!-- Thanks for opening a pull request! --> <!-- In the case this PR will resolve an issue, please replace ${GITHUB_ISSUE_ID} below with the actual Github issue id. --> <!-- Closes #${GITHUB_ISSUE_ID} --> # Rationale for this change Heading levels of subsections of `Code standards` are incorrect such that subsection headings are rendered on the same level as `Code standards`. ## Are these changes tested? Doc changes only. ## Are there any user-facing changes? <!-- In the case of user-facing changes, please add the changelog label. -->
1 parent 06b9467 commit 370e770

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

mkdocs/docs/contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ To rebuild the containers from scratch.
159159

160160
Below are the formalized conventions that we adhere to in the PyIceberg project. The goal of this is to have a common agreement on how to evolve the codebase, but also using it as guidelines for newcomers to the project.
161161

162-
## API Compatibility
162+
### API Compatibility
163163

164164
It is important to keep the Python public API compatible across versions. The Python official [PEP-8](https://peps.python.org/pep-0008/) defines public methods as: _Public attributes should have no leading underscores_. This means not removing any methods without any notice, or removing or renaming any existing parameters. Adding new optional parameters is okay.
165165

@@ -202,12 +202,12 @@ Which will warn:
202202
Deprecated in 0.1.0, will be removed in 0.2.0. The old_property is deprecated. Please use the something_else property instead.
203203
```
204204

205-
## Type annotations
205+
### Type annotations
206206

207207
For the type annotation the types from the `Typing` package are used.
208208

209209
PyIceberg offers support from Python 3.9 onwards, we can't use the [type hints from the standard collections](https://peps.python.org/pep-0585/).
210210

211-
## Third party libraries
211+
### Third party libraries
212212

213213
PyIceberg naturally integrates into the rich Python ecosystem, however it is important to be hesitant adding third party packages. Adding a lot of packages makes the library heavyweight, and causes incompatibilities with other projects if they use a different version of the library. Also, big libraries such as `s3fs`, `adlfs`, `pyarrow`, `thrift` should be optional to avoid downloading everything, while not being sure if is actually being used.

0 commit comments

Comments
 (0)