Skip to content

Commit

Permalink
chore: Update Yore comments
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Aug 14, 2024
1 parent 8cdffe9 commit d56da0a
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/reference/api/loggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## **Main API**

<!-- YORE: Bump 1: Replace line with `::: griffe.logger`.
<!-- YORE: Bump 1: Replace line with `::: griffe.logger`. -->
<!-- -->

::: griffe.Logger
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ plugins:
handlers:
python:
import:
# YORE: SOL 3.13: Replace `3.13` with `3` within line.
# YORE: BOL 3.13: Replace `3.13` with `3` within line.
- url: https://docs.python.org/3.13/objects.inv
domains: [std, py]
paths: [src, scripts, .]
Expand Down
2 changes: 1 addition & 1 deletion src/_griffe/extensions/hybrid.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deprecated. This extension provides an hybrid behavior while loading data.

# YORE: Bump 1: Remove module.
# YORE: Bump 1: Remove file.

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion src/_griffe/logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def _patch_loggers(cls, get_logger_func: Callable) -> None:
cls._default_logger = get_logger_func


# YORE: Bump 1: Uncomment block.
# YORE: Bump 1: Regex-replace `^# ?` with `` within block.
# logger: Logger = Logger._get()
# """Our global logger, used throughout the library.
#
Expand Down
9 changes: 4 additions & 5 deletions src/griffe/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,8 @@
from _griffe.importer import dynamic_import, sys_path
from _griffe.loader import GriffeLoader, load, load_git, load_pypi

# YORE: Bump 1: Replace `get_logger` with `logger` within line.
# YORE: Bump 1: Replace `, patch_loggers` with `` within line.
# YORE: Bump 1: Replace `get_logger` with `get_logger, logger` within line.
# YORE: Bump 1: Replace `patch_logger, ` with `` within line.
from _griffe.logger import Logger, get_logger, patch_logger, patch_loggers
from _griffe.merger import merge_stubs
from _griffe.mixins import (
Expand Down Expand Up @@ -414,7 +414,6 @@
"get_expression",
"get_instance_names",
"get_latest_tag",
# YORE: Bump 1: Remove line.
"get_logger",
"get_name",
"get_names",
Expand All @@ -430,7 +429,7 @@
"load_extensions",
"load_git",
"load_pypi",
# YORE: Bump 1: Uncomment line.
# YORE: Bump 1: Replace `# ` with ``.
# "logger",
"main",
"merge_stubs",
Expand All @@ -442,8 +441,8 @@
"parse_numpy",
"parse_sphinx",
"parsers",
"patch_logger",
# YORE: Bump 1: Remove line.
"patch_logger",
"patch_loggers",
"relative_to_absolute",
"safe_get__all__",
Expand Down

0 comments on commit d56da0a

Please sign in to comment.