Skip to content

Commit

Permalink
[docs] Improve the update_file docs (#513)
Browse files Browse the repository at this point in the history
This is a documentation-only commit. It updates the docs for the update_file function to explain what the different parameters do and adds a hyperlink to the GitHub API docs
  • Loading branch information
beyarkay authored Jan 9, 2024
1 parent 465c461 commit 80395e9
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/api/repos.rs
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,17 @@ impl<'octo> RepoHandler<'octo> {
)
}

/// Update an existing file.
///
/// - `path`: the path of the updated file.
/// - `message`: the message of the commit used to update the file
/// - `content`: the updated contents of the file (base64 encoding is done
/// automatically).
/// - `sha`: the blob SHA of the file being updated. This can be obtained
/// using the [RepoHandler::get_content] function.
///
/// [GitHub API documentation](https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#create-or-update-file-contents)
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let blob_sha = "";
Expand Down

0 comments on commit 80395e9

Please sign in to comment.