Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize Python API for Garden Lattice book materials and add understanding book section #223

Merged
merged 30 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
01d2a5b
organize code for garden lattice focused work
d33bs Dec 28, 2024
8f82228
linting
d33bs Dec 28, 2024
41a35c4
Merge remote-tracking branch 'upstream/main' into check-capability
d33bs Dec 30, 2024
5ff8c0d
stubs for content
d33bs Dec 30, 2024
54c384a
package api stub
d33bs Dec 30, 2024
2012f34
linting and autodoc
d33bs Dec 30, 2024
0958ca4
Update _toc.yml
d33bs Dec 30, 2024
7a2fcfe
properly build autodoc docs
d33bs Dec 31, 2024
f927702
move is_citable
d33bs Dec 31, 2024
bf6b46f
add understanding content
d33bs Dec 31, 2024
78f62a8
add contributing citation
d33bs Dec 31, 2024
1d865a3
further content
d33bs Jan 2, 2025
12ef44b
add further understanding docs
d33bs Jan 3, 2025
a9fd244
remove connectedness and practicality sections
d33bs Jan 3, 2025
b55de4f
[pre-commit.ci lite] apply automatic fixes
pre-commit-ci-lite[bot] Jan 3, 2025
6ceec85
update default file extensions
d33bs Jan 5, 2025
6b6a247
update docstring
d33bs Jan 5, 2025
d81565e
resolve typo
d33bs Jan 5, 2025
a604922
clarify docstring on ecosyste.ms vs ecosystems
d33bs Jan 5, 2025
5bc5f92
clarify docstring and add period
d33bs Jan 5, 2025
1222ae1
Apply suggestions from code review
d33bs Jan 5, 2025
f68d887
[pre-commit.ci lite] apply automatic fixes
pre-commit-ci-lite[bot] Jan 5, 2025
15816f0
Merge branch 'garden-lattice-materials' of https://github.com/d33bs/a…
d33bs Jan 6, 2025
7f0e584
move api definition earlier
d33bs Jan 6, 2025
6230de7
expand on roles and care with contributing
d33bs Jan 6, 2025
a0d8509
Merge remote-tracking branch 'upstream/main' into garden-lattice-mate…
d33bs Jan 6, 2025
c765997
post-merge update to reorganize
d33bs Jan 6, 2025
e48a0d0
comment on what the code cannot say
d33bs Jan 6, 2025
56856a3
linting
d33bs Jan 6, 2025
ea33ab0
update coverage
d33bs Jan 6, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ default_language_version:
python: python3.11
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
# Ensures no trailing whitespace in files, which can cause
# merge conflicts and makes diffs harder to read.
Expand Down Expand Up @@ -39,7 +39,7 @@ repos:
- id: poetry-check

- repo: https://github.com/tox-dev/pyproject-fmt
rev: "2.2.4"
rev: "v2.5.0"
d33bs marked this conversation as resolved.
Show resolved Hide resolved
hooks:
# Formats the `pyproject.toml` file to follow a consistent structure
# and style, making it easier to read and maintain.
Expand All @@ -62,7 +62,7 @@ repos:
- tomli

- repo: https://github.com/executablebooks/mdformat
rev: 0.7.17
rev: 0.7.21
hooks:
# Formats Markdown files to ensure a consistent style,
# making the documentation easier to read and maintain.
Expand All @@ -79,20 +79,30 @@ repos:
- id: yamllint

- repo: https://github.com/psf/black
rev: 24.4.2
rev: 24.10.0
hooks:
# Formats Python code to follow the Black code style,
# promoting consistency and readability across the codebase.
- id: black

- repo: https://github.com/asottile/blacken-docs
rev: 1.18.0
rev: 1.19.1
hooks:
# Formats code blocks in Markdown and reStructuredText
# documentation files with Black's style, ensuring
# consistency in inline code snippets.
- id: blacken-docs

- repo: https://github.com/PyCQA/autoflake
rev: v2.3.1
hooks:
# removes unused imports automatically
- id: autoflake
args:
- "--remove-all-unused-imports"
- "--in-place"
- "--ignore-init-module-imports"

- repo: https://github.com/PyCQA/isort
rev: 5.13.2
hooks:
Expand All @@ -101,7 +111,7 @@ repos:
- id: isort

- repo: https://github.com/PyCQA/bandit
rev: 1.7.9
rev: 1.8.0
hooks:
# Scans Python code for common security issues, helping to identify
# and fix potential vulnerabilities in the codebase.
Expand All @@ -110,14 +120,14 @@ repos:
additional_dependencies: ["bandit[toml]"]

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: "v0.5.2"
rev: "v0.8.4"
hooks:
# A fast linter that checks for stylistic errors in Python code,
# helping maintain code quality and adherence to style guidelines.
- id: ruff

- repo: https://github.com/rhysd/actionlint
rev: v1.7.1
rev: v1.7.5
hooks:
# Lints GitHub Actions workflows, ensuring syntax correctness and
# reducing errors in continuous integration and automation configurations.
Expand All @@ -131,14 +141,14 @@ repos:
- id: validate-cff

- repo: https://github.com/jendrikseipp/vulture
rev: 'v2.13'
rev: 'v2.14'
d33bs marked this conversation as resolved.
Show resolved Hide resolved
hooks:
# Detects unused code, helping identify dead code that can be removed
# to keep the codebase lean and maintainable.
- id: vulture

- repo: https://github.com/nbQA-dev/nbQA
rev: 1.8.5
rev: 1.9.1
hooks:
# Runs Black formatting on Jupyter notebooks, ensuring code cells
# adhere to the Black code style.
Expand Down
Loading
Loading