Create category.pyi #30093
Open
Create category.pyi #30093
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @Santt997, I suggest you install and run the precommit hooks to help fix the linting errors https://matplotlib.org/devdocs/devel/development_setup.html#install-pre-commit-hooks |
story645
reviewed
May 23, 2025
Comment on lines
+1
to
+11
| """ | ||
| Plotting of string "category" data: ``plot(['d', 'f', 'a'], [1, 2, 3])`` will | ||
| plot three points with x-axis values of 'd', 'f', 'a'. | ||
|
|
||
| See :doc:`/gallery/lines_bars_and_markers/categorical_variables` for an | ||
| example. | ||
|
|
||
| The module uses Matplotlib's `matplotlib.units` mechanism to convert from | ||
| strings to integers and provides a tick locator, a tick formatter, and the | ||
| `.UnitData` class that creates and stores the string-to-integer mapping. | ||
| """ |
There was a problem hiding this comment.
The .pyi files don't typically have doc strings
| class StrCategoryConverter(ConversionInterface): | ||
| @staticmethod | ||
| def convert( | ||
| value: Union[str, Iterable[str]], |
There was a problem hiding this comment.
Suggested change
| value: Union[str, Iterable[str]], | |
| value: str | Iterable[str], |
The .pyi files typically use the union operator rather than explicit union, please make this change to all the unions in this file
https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html
|
|
||
| class StrCategoryFormatter(ticker.Formatter): | ||
| def __init__(self, units_mapping: Dict[str, int]) -> None: ... | ||
| def __call__(self, x: float, pos: Optional[int] = None) -> str: ... |
There was a problem hiding this comment.
Suggested change
| def __call__(self, x: float, pos: Optional[int] = None) -> str: ... | |
| def __call__(self, x: float, pos: int | None) -> str: ... |
also use the | convetion for optional, see https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html
|
|
||
| class UnitData: | ||
| _mapping: OrderedDict[Union[str, bytes], int] | ||
| def __init__( |
There was a problem hiding this comment.
I think ._counter also needs to be documented
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
PR checklist