Document to_css_class as a supported internal#2856
Open
ColumbusLabs wants to merge 1 commit into
Open
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
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.
What
Document
datasette.utils.to_css_class()as a supported internal utility and register it with Datasette's@documentedsafeguard.Why
Plugins already use this helper, but it was absent from the documented internals. That left its support status unclear and meant the documentation registry could not protect its API section from accidental removal.
Fixes #1743
Details
internals_utils_to_css_classanchor and decorator registrationTesting
uv run pytest -n auto -m 'not serial'(2269 passed, 40 skipped, 6 xfailed, 15 xpassed)uv run pytest -m serial(36 passed)uv run pytest tests/test_docs.py::test_functions_marked_with_documented_are_documenteduv run pytest tests/test_utils.py -k to_css_classgit diff --check