Drop get_ prefix from fns
#437
Merged
Conversation
This file contains 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
MarijnS95
force-pushed
the
drop-get-prefix
branch
2 times, most recently
from
bee0d54
to
c424376
Compare
According to [Rust's C-GETTER convention] function names should not have a `get_` prefix, and we maintain this standard in some but not all parts of the `ndk`. Consistenize that by dropping it everywhere, and add `doc(alias)`es to at least these functions (as I have been doing to new API wrappers added over the past few months too) to make it easier for users to find by the original NDK C symbol name. In addition the `audio` module received some extra doc cleanup to get rid of redundant `Available since API level xx.` doc-comments (these are already provided via `feature`s and `doc_cfg`) as well as vague statements about integer return values when the return type has been translated to a `Return<()>`. [Rust's C-GETTER convention]: https://rust-lang.github.io/api-guidelines/naming.html#getter-names-follow-rust-convention-c-getter
MarijnS95
force-pushed
the
drop-get-prefix
branch
from
c424376
to
2492580
Compare
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.
According to Rust's C-GETTER convention function names should not have a
get_prefix, and we maintain this standard in some but not all parts of thendk. Consistenize that by dropping it everywhere, and adddoc(alias)es to at least these functions (as I have been doing to new API wrappers added over the past few months too) to make it easier for users to find by the original NDK C symbol name.In addition the
audiomodule received some extra doc cleanup to get rid of redundantAvailable since API level xx.doc-comments (these are already provided viafeatures anddoc_cfg) as well as vague statements about integer return values when the return type has been translated to aReturn<()>.