Remove misleading reference doc type alias renames#687
Draft
danielporterda wants to merge 1 commit into
Draft
Conversation
c8747ee to
dcdb3ff
Compare
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.
Summary
NewType = OldTypealiases left from PR Tighten Python reference doc types #684 in the Python reference-doc typing surface.TypedDictshapes.JsonValue, object, array, and nav item types instead of relying oncast(...).JsonValue,MintlifyNavItem, andMintlifyNavItems.Validation
direnv exec . python3 -m compileall -q scripts/generated_reference_nav.py scripts/reference_nav.py src/x2mdx/asyncapi/lifecycle.py src/x2mdx/asyncapi/models.py src/x2mdx/asyncapi/snapshots.py src/x2mdx/daml_json/models.py src/x2mdx/daml_json/snapshots.py src/x2mdx/jvm_docs/snapshots.py src/x2mdx/mintlify.py src/x2mdx/openrpc/lifecycle.py src/x2mdx/openrpc/models.py src/x2mdx/openrpc/snapshots.py src/x2mdx/protobuf/models.py src/x2mdx/protobuf/snapshots.py src/x2mdx/typedoc/models.py src/x2mdx/typedoc/snapshots.py src/x2mdx/types.pydirenv exec . ruff check scripts/generated_reference_nav.py scripts/reference_nav.py src/x2mdx/asyncapi/lifecycle.py src/x2mdx/asyncapi/models.py src/x2mdx/asyncapi/snapshots.py src/x2mdx/daml_json/models.py src/x2mdx/daml_json/snapshots.py src/x2mdx/jvm_docs/snapshots.py src/x2mdx/mintlify.py src/x2mdx/openrpc/lifecycle.py src/x2mdx/openrpc/models.py src/x2mdx/openrpc/snapshots.py src/x2mdx/protobuf/models.py src/x2mdx/protobuf/snapshots.py src/x2mdx/typedoc/models.py src/x2mdx/typedoc/snapshots.py src/x2mdx/types.pydirenv exec . mypy scripts/generated_reference_nav.py scripts/reference_nav.py src/x2mdx/asyncapi/lifecycle.py src/x2mdx/asyncapi/models.py src/x2mdx/asyncapi/snapshots.py src/x2mdx/daml_json/models.py src/x2mdx/daml_json/snapshots.py src/x2mdx/jvm_docs/snapshots.py src/x2mdx/mintlify.py src/x2mdx/openrpc/lifecycle.py src/x2mdx/openrpc/models.py src/x2mdx/openrpc/snapshots.py src/x2mdx/protobuf/models.py src/x2mdx/protobuf/snapshots.py src/x2mdx/typedoc/models.py src/x2mdx/typedoc/snapshots.py src/x2mdx/types.pysrc/x2mdx,scripts/generated_reference_nav.py, andscripts/reference_nav.pyfinds nocast(...)usage.PYTHONDONTWRITEBYTECODE=1 direnv exec . python3 -m pytest tests/test_api_reference_navigation.py tests/test_asyncapi.py tests/test_openrpc.py tests/test_daml_json.py tests/test_jvm_docs.py tests/test_protobuf.py tests/test_protobuf_nav.py tests/test_typedoc.py tests/test_typescript_bindings_reference.py -k 'not test_build_report_requires_status_for_non_deprecated_types and not test_build_report_tracks_lifecycle_from_local_jars and not test_cli_builds_pages_and_updates_docs_json and not test_cli_builds_overview_and_package_pages'passed: 31 passed, 4 deselected.git diff --checkKnown base failures
The full focused pytest command currently has 4 failures that reproduce outside this branch:
tests/test_jvm_docs.pycases fail while building fixture jars under Python 3.14 withstruct.error: 'H' format requires 0 <= number <= 65535.tests/test_protobuf.py::ProtobufTests::test_cli_builds_overview_and_package_pagesexpectshref="packages/com-example-v1", while the renderer emitshref="./packages/com-example-v1".