Skip to content

Incorrect documentation for LoadContext.read_asset_bytes #10302

New issue
New issue
Closed
#10352
Closed
Incorrect documentation for LoadContext.read_asset_bytes#10302
#10352
Labels
C-DocsAn addition or correction to our documentationS-Needs-TriageThis issue needs to be labelled

Description

@papow65
papow65
opened on Oct 29, 2023

How can Bevy's documentation be improved?

The documentation for LoadContext.read_asset_bytes is incorrect. It is copied from LoadContext.asset_path.

bevy/crates/bevy_asset/src/loader.rs

Lines 410 to 416 in 0c2c52a

/// Gets the source asset path for this load context.
pub fn asset_path(&self) -> &AssetPath<'static> {
&self.asset_path
}
/// Gets the source asset path for this load context.
pub async fn read_asset_bytes<'b, 'c>(

Activity

  1. papow65
    added
    C-DocsAn addition or correction to our documentation
    S-Needs-TriageThis issue needs to be labelled
    on Oct 29, 2023
  2. github-merge-queue
    added a commit that references this issue on Nov 3, 2023

    Corrected incorrect doc comment on read_asset_bytes (#10352)

    708569c
  3. alice-i-cecile
    closed this as completedin #10352on Nov 3, 2023
  4. aevyrie
    added a commit that references this issue on Nov 4, 2023

    Review feedback

    1523014
  5. ameknite
    added a commit that references this issue on Nov 6, 2023

    Corrected incorrect doc comment on read_asset_bytes (bevyengine#10352)

    2631f4c
  6. rdrpenguin04
    added a commit that references this issue on Jan 9, 2024

    Corrected incorrect doc comment on read_asset_bytes (bevyengine#10352)

    301121b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-DocsAn addition or correction to our documentationS-Needs-TriageThis issue needs to be labelled

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions