Apply suggestions from code review

Thanks!

Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>

Author: johnslavik

docs/guide/contributors/architecture.md

@@ -112,6 +112,7 @@ The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test mod
 Griffe is split into two pieces: the library and the CLI.
 
 Each of them has an internal API contained within an `_internal` folder:
+
 - `packages/griffelib/src/griffe/_internal` for the library,
 - `packages/griffecli/src/griffecli/_internal` for the CLI.
 

docs/installation.md

@@ -61,7 +61,7 @@ Griffe is a Python package, so you can install it with your favorite Python pack
 
 ## Install as a library only
 
-If you only need the library for API introspection and analysis without the CLI tool, you can install just `griffelib`:
+If you only need the library for API introspection and analysis without the CLI tool, you can install `griffelib`:
 
 === ":simple-python: pip"
      ```bash
@@ -118,7 +118,7 @@ If you only need the library for API introspection and analysis without the CLI
 
      </div>
 
-This installs the `griffe` package as usual, but without the CLI program, nor its API, nor its dependencies.
+This installs the `griffe` package as usual, but without the CLI program and its dependencies.
 
 ## Install as a tool only
 

packages/griffelib/src/griffe/__init__.py

@@ -8,8 +8,7 @@
 Extract the structure, the frame, the skeleton of your project,
 to generate API documentation or find breaking changes in your API.
 
-The entirety of the library API is exposed here, in the top-level `griffelib` module.
-For backward compatibility, you can also import from `griffe` which re-exports everything.
+The entirety of the library API is exposed here, in the top-level `griffe` module.
 
 All messages written to standard output or error are logged using the `logging` module.
 Our logger's name is set to `"griffe"` and is public (you can rely on it).
@@ -613,5 +612,5 @@ def __getattr__(attr: str) -> object:
         raise AttributeError(attr)
 else:
     __all__ += __cli_all__  # noqa: PLE0605
-    # Ignore any reexpected API in internal API tests.
+    # Ignore any re-exported API in internal API tests.
     _REEXPORTED_EXTERNAL_API = set(__cli_all__)

packages/griffelib/src/griffe/_internal/finder.py

@@ -470,7 +470,7 @@ def _handle_pth_file(path: Path) -> list[_SP]:
 def _handle_editable_module(path: Path) -> list[_SP]:
     if _match_pattern(path.name, (*_editable_editables_patterns, *_editable_scikit_build_core_patterns)):
         # Support for how 'editables' write these files:
-        # example line: `F.map_module('griffe', '/media/data/dev/griffelib/packages/griffe/src/griffe/__init__.py')`.
+        # example line: `F.map_module('pkg', '/data/dev/pkg/src/pkg/__init__.py')`.
         # And how 'scikit-build-core' writes these files:
         # example line: `install({'griffe': '/media/data/dev/griffelib/packages/griffe/src/griffe/__init__.py'}, {'cmake_example': ...}, None, False, True)`.
         try:
@@ -483,7 +483,7 @@ def _handle_editable_module(path: Path) -> list[_SP]:
         return [_SP(new_path)]
     if _match_pattern(path.name, _editable_setuptools_patterns):
         # Support for how 'setuptools' writes these files:
-        # example line: `MAPPING = {'griffe': '/media/data/dev/griffe/packages/griffelib/src/griffe', 'briffe': '/media/data/dev/griffe/src/briffe'}`.
+        # example line: `MAPPING = {'pkg': '/data/dev/pkg/src/pkg', 'pkg2': '/data/dev/pkg/src/pkg2'}`.
         # with annotation: `MAPPING: dict[str, str] = {...}`.
         parsed_module = ast.parse(path.read_text(encoding="utf8"))
         for node in parsed_module.body:
@@ -508,7 +508,7 @@ def _handle_editable_module(path: Path) -> list[_SP]:
                 and node.value.func.id == "install"
                 and isinstance(node.value.args[1], ast.Constant)
             ):
-                build_path = Path(node.value.args[1].value, "packages/griffelib/src")  # type: ignore[arg-type]
+                build_path = Path(node.value.args[1].value, "src")  # type: ignore[arg-type]
                 # NOTE: What if there are multiple packages?
                 pkg_name = next(build_path.iterdir()).name
                 return [_SP(build_path, always_scan_for=pkg_name)]