Fix pyproject.toml workspace config and restore griffe CLI branding by Copilot · Pull Request #436 · mkdocstrings/griffe

Copilot · 2025-11-30T21:15:02Z

For reviewers

I did not use AI
I used AI and thoroughly reviewed every code/docs change

Description of the change

Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.

Changes:

pyproject.toml: Added tool.uv.sources section declaring griffelib and griffecli as workspace members (fixes uv sync failure)
CLI branding: Changed argparse prog from griffelib to griffe for backward-compatible command-line usage
Documentation: Restored all CLI examples to use griffe check/griffe dump instead of griffecli
installation.md: Added "Running Griffe" section documenting python -m griffecli as an alternative
Internal API references: Updated all griffe._internal references to griffelib._internal in documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structure

$ griffe --helpusage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Relevant resources

Continuation of change: Reorganize as griffe and griffelib packages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closeschange: Split griffe to griffe and griffelib packages #408
Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

johnslavik · 2025-11-30T21:49:25Z

 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.

-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.


griffe._internal.finder -- this and similar are wrong

Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.

johnslavik · 2025-11-30T23:44:53Z

@copilot Do stuff

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Copilot · 2025-11-30T23:50:36Z

@copilot Do stuff

Could you please clarify what specific changes or actions you'd like me to make?

Copilot · 2025-11-30T21:15:02Z

For reviewers

I did not use AI
I used AI and thoroughly reviewed every code/docs change

Description of the change

Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.

Changes:

pyproject.toml: Added tool.uv.sources section declaring griffelib and griffecli as workspace members (fixes uv sync failure)
CLI branding: Changed argparse prog from griffelib to griffe for backward-compatible command-line usage
Documentation: Restored all CLI examples to use griffe check/griffe dump instead of griffecli
installation.md: Added "Running Griffe" section documenting python -m griffecli as an alternative
Internal API references: Updated all griffe._internal references to griffelib._internal in documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structure

$ griffe --helpusage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Relevant resources

Continuation of change: Reorganize as griffe and griffelib packages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closeschange: Split griffe to griffe and griffelib packages #408
Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

johnslavik · 2025-11-30T21:49:25Z

 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.

-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.


griffe._internal.finder -- this and similar are wrong

Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.

johnslavik · 2025-11-30T23:44:53Z

@copilot Do stuff

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Copilot · 2025-11-30T23:50:36Z

@copilot Do stuff

Could you please clarify what specific changes or actions you'd like me to make?

Copilot · 2025-11-30T21:15:02Z

For reviewers

I did not use AI
I used AI and thoroughly reviewed every code/docs change

Description of the change

Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.

Changes:

pyproject.toml: Added tool.uv.sources section declaring griffelib and griffecli as workspace members (fixes uv sync failure)
CLI branding: Changed argparse prog from griffelib to griffe for backward-compatible command-line usage
Documentation: Restored all CLI examples to use griffe check/griffe dump instead of griffecli
installation.md: Added "Running Griffe" section documenting python -m griffecli as an alternative
Internal API references: Updated all griffe._internal references to griffelib._internal in documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structure

$ griffe --helpusage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Relevant resources

Continuation of change: Reorganize as griffe and griffelib packages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closeschange: Split griffe to griffe and griffelib packages #408
Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

johnslavik · 2025-11-30T21:49:25Z

 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.

-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.


griffe._internal.finder -- this and similar are wrong

Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.

johnslavik · 2025-11-30T23:44:53Z

@copilot Do stuff

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Copilot · 2025-11-30T23:50:36Z

@copilot Do stuff

Could you please clarify what specific changes or actions you'd like me to make?

Copilot · 2025-11-30T21:15:02Z

For reviewers

I did not use AI
I used AI and thoroughly reviewed every code/docs change

Description of the change

Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.

Changes:

pyproject.toml: Added tool.uv.sources section declaring griffelib and griffecli as workspace members (fixes uv sync failure)
CLI branding: Changed argparse prog from griffelib to griffe for backward-compatible command-line usage
Documentation: Restored all CLI examples to use griffe check/griffe dump instead of griffecli
installation.md: Added "Running Griffe" section documenting python -m griffecli as an alternative
Internal API references: Updated all griffe._internal references to griffelib._internal in documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structure

$ griffe --helpusage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Relevant resources

Continuation of change: Reorganize as griffe and griffelib packages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closeschange: Split griffe to griffe and griffelib packages #408
Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

johnslavik · 2025-11-30T21:49:25Z

 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.

-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.


griffe._internal.finder -- this and similar are wrong

Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.

johnslavik · 2025-11-30T23:44:53Z

@copilot Do stuff

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Copilot · 2025-11-30T23:50:36Z

@copilot Do stuff

Could you please clarify what specific changes or actions you'd like me to make?

Copilot · 2025-11-30T21:15:02Z

For reviewers

I did not use AI
I used AI and thoroughly reviewed every code/docs change

Description of the change

Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.

Changes:

pyproject.toml: Added tool.uv.sources section declaring griffelib and griffecli as workspace members (fixes uv sync failure)
CLI branding: Changed argparse prog from griffelib to griffe for backward-compatible command-line usage
Documentation: Restored all CLI examples to use griffe check/griffe dump instead of griffecli
installation.md: Added "Running Griffe" section documenting python -m griffecli as an alternative
Internal API references: Updated all griffe._internal references to griffelib._internal in documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structure

$ griffe --helpusage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Relevant resources

Continuation of change: Reorganize as griffe and griffelib packages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closeschange: Split griffe to griffe and griffelib packages #408
Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

johnslavik · 2025-11-30T21:49:25Z

 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.

-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.


griffe._internal.finder -- this and similar are wrong

Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.

johnslavik · 2025-11-30T23:44:53Z

@copilot Do stuff

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Copilot · 2025-11-30T23:50:36Z

@copilot Do stuff

Could you please clarify what specific changes or actions you'd like me to make?

Copilot · 2025-11-30T21:15:02Z

For reviewers

I did not use AI
I used AI and thoroughly reviewed every code/docs change

Description of the change

Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.

Changes:

pyproject.toml: Added tool.uv.sources section declaring griffelib and griffecli as workspace members (fixes uv sync failure)
CLI branding: Changed argparse prog from griffelib to griffe for backward-compatible command-line usage
Documentation: Restored all CLI examples to use griffe check/griffe dump instead of griffecli
installation.md: Added "Running Griffe" section documenting python -m griffecli as an alternative
Internal API references: Updated all griffe._internal references to griffelib._internal in documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structure

$ griffe --helpusage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Relevant resources

Continuation of change: Reorganize as griffe and griffelib packages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closeschange: Split griffe to griffe and griffelib packages #408
Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

johnslavik · 2025-11-30T21:49:25Z

 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.

-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.


griffe._internal.finder -- this and similar are wrong

Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.

johnslavik · 2025-11-30T23:44:53Z

@copilot Do stuff

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Copilot · 2025-11-30T23:50:36Z

@copilot Do stuff

Could you please clarify what specific changes or actions you'd like me to make?

Copilot · 2025-11-30T21:15:02Z

For reviewers

I did not use AI
I used AI and thoroughly reviewed every code/docs change

Description of the change

Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.

Changes:

pyproject.toml: Added tool.uv.sources section declaring griffelib and griffecli as workspace members (fixes uv sync failure)
CLI branding: Changed argparse prog from griffelib to griffe for backward-compatible command-line usage
Documentation: Restored all CLI examples to use griffe check/griffe dump instead of griffecli
installation.md: Added "Running Griffe" section documenting python -m griffecli as an alternative
Internal API references: Updated all griffe._internal references to griffelib._internal in documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structure

$ griffe --helpusage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Relevant resources

Continuation of change: Reorganize as griffe and griffelib packages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closeschange: Split griffe to griffe and griffelib packages #408
Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

johnslavik · 2025-11-30T21:49:25Z

 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.

-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.


griffe._internal.finder -- this and similar are wrong

Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.

johnslavik · 2025-11-30T23:44:53Z

@copilot Do stuff

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Copilot · 2025-11-30T23:50:36Z

@copilot Do stuff

Could you please clarify what specific changes or actions you'd like me to make?

Copilot · 2025-11-30T21:15:02Z

For reviewers

I did not use AI
I used AI and thoroughly reviewed every code/docs change

Description of the change

Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.

Changes:

pyproject.toml: Added tool.uv.sources section declaring griffelib and griffecli as workspace members (fixes uv sync failure)
CLI branding: Changed argparse prog from griffelib to griffe for backward-compatible command-line usage
Documentation: Restored all CLI examples to use griffe check/griffe dump instead of griffecli
installation.md: Added "Running Griffe" section documenting python -m griffecli as an alternative
Internal API references: Updated all griffe._internal references to griffelib._internal in documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structure

$ griffe --helpusage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Relevant resources

Continuation of change: Reorganize as griffe and griffelib packages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closeschange: Split griffe to griffe and griffelib packages #408
Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

johnslavik · 2025-11-30T21:49:25Z

 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.

-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.


griffe._internal.finder -- this and similar are wrong

Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.

johnslavik · 2025-11-30T23:44:53Z

@copilot Do stuff

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Copilot · 2025-11-30T23:50:36Z

@copilot Do stuff

Could you please clarify what specific changes or actions you'd like me to make?

Initial plan
5192321

CopilotAI assigned Copilot and johnslavik Nov 30, 2025

CopilotAI mentioned this pull request Nov 30, 2025
change: Split to griffe + griffecli + griffelib uv workspace #434
Merged

Copilotstarted work on behalf of johnslavik November 30, 2025 21:15 View session

Fix missing pyproject.toml config and CLI program name
b4c1118
Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

CopilotAI changed the title ~~[WIP] Reorganize as griffe and griffelib packages with uv workspaces~~Fix pyproject.toml workspace config and restore griffe CLI brandingNov 30, 2025

CopilotAI requested a review from johnslavik November 30, 2025 21:29

Copilotfinished work on behalf of johnslavik November 30, 2025 21:29

johnslavik reviewed Nov 30, 2025
View reviewed changes

Copilotstarted work on behalf of johnslavik November 30, 2025 23:44 View session

Fix griffe._internal references to griffelib._internal in docs
8ecd876
Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

CopilotAI requested a review from johnslavik November 30, 2025 23:49

Copilotfinished work on behalf of johnslavik November 30, 2025 23:49

Copilotstarted work on behalf of johnslavik November 30, 2025 23:50 View session

johnslavik approved these changes Nov 30, 2025
View reviewed changes

johnslavik marked this pull request as ready for review November 30, 2025 23:50

johnslavik merged commit e254389 into b/migrateNov 30, 2025
1 of 2 checks passed

CopilotAI requested a review from johnslavik November 30, 2025 23:50

Copilot stopped work on behalf of johnslavik due to an error November 30, 2025 23:50
Copilot has encountered an error. See logs for additional details.

pawamoy deleted the copilot/sub-pr-434-again branch February 20, 2026 15:44