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

refactor: Rework public API and docs #304

Merged
merged 57 commits into from
Jul 14, 2024
Merged

Conversation

pawamoy
Copy link
Member

@pawamoy pawamoy commented Jul 10, 2024

Replaces #290

@pawamoy pawamoy changed the title Public api and docs clean refactor: Rework public API and docs Jul 10, 2024
pawamoy added 25 commits July 13, 2024 22:46
By using string and integer enumerations, the enumeration values can then be compared to actual strings and integers, without using their `.value` attribute.

This also means that the enumeration values can now be serialized to JSON without special casing them.
Before this commit we supported having multiple loggers. After this commit we only use one single, global logger, with the name `"griffe"`. It allows us to simplify a few other things related to logging.

To keep this backward compatible before v1, we mainly used Yore comments.
It's parsed as PEP 440 so the trailing zeros are not useful.
@pawamoy pawamoy force-pushed the public-api-and-docs-clean branch from 4a564a3 to bb56bcd Compare July 13, 2024 20:47
@pawamoy pawamoy marked this pull request as ready for review July 13, 2024 20:57
@pawamoy pawamoy force-pushed the public-api-and-docs-clean branch 4 times, most recently from b52d99b to cf0cf29 Compare July 13, 2024 21:25
@pawamoy pawamoy force-pushed the public-api-and-docs-clean branch from cf0cf29 to 742b39f Compare July 13, 2024 21:31
@pawamoy pawamoy merged commit 7207449 into main Jul 14, 2024
51 of 53 checks passed
@pawamoy pawamoy deleted the public-api-and-docs-clean branch November 26, 2024 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant