Make accidental access of #[doc(hidden)] symbols more explicit - #1651
Merged
Conversation
Symbols marked `#[doc(hidden)]` are explicitly *not* part of the public API, per lib.rs documentation. But sometimes they look like regular methods and users may accidentally use them, and be surprised about unannounced breaking changes. Clarifies this in different ways: * add `__` prefix for some internal APIs * gate behind an internal feature for itests * remove redundant methods such as `ClassId::is_none()`
Bromeon
added
the
maintenance
|
API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-1651 |
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
2 participants
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.
Symbols marked
#[doc(hidden)]are explicitly not part of the public API, per lib.rs documentation. But sometimes they look like regular methods and users may accidentally use them, and be surprised about unannounced breaking changes.Clarifies this in different ways:
__prefix for some internal APIsClassId::is_none()