This is an automated email from the ASF dual-hosted git repository.
kevinjqliu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-python.git
The following commit(s) were added to refs/heads/main by this push:
new 370e7703 Fix heading levels of subsections of Code standards (#2393)
370e7703 is described below
commit 370e770383c9c129aff2fe24cc92a68981688159
Author: Manu Zhang <[email protected]>
AuthorDate: Thu Aug 28 02:45:32 2025 +0800
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.
-->
---
mkdocs/docs/contributing.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/mkdocs/docs/contributing.md b/mkdocs/docs/contributing.md
index 454da882..4ff3541b 100644
--- a/mkdocs/docs/contributing.md
+++ b/mkdocs/docs/contributing.md
@@ -159,7 +159,7 @@ To rebuild the containers from scratch.
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.
-## API Compatibility
+### API Compatibility
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.
@@ -202,12 +202,12 @@ Which will warn:
Deprecated in 0.1.0, will be removed in 0.2.0. The old_property is deprecated.
Please use the something_else property instead.
```
-## Type annotations
+### Type annotations
For the type annotation the types from the `Typing` package are used.
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/).
-## Third party libraries
+### Third party libraries
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.
