youwen5/cartographer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update doccomment for get_from_endpoint

Browse source
This commit is contained in:
Youwen Wu 2024-09-12 14:50:59 -07:00
parent 5cb87b1adf
commit 6eef285c45
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/libcanvas.rs
View file

@ -32,7 +32,8 @@ impl CanvasClient {
Ok(CanvasClient { client, api_url })
}
/// Call an API endpoint. Expects the relative path of the endpoint after the base API URL.
/// Call an API endpoint on the provided Canvas API with the authorization token. Expects the
/// relative path of the endpoint after the base API URL.
/// Returns the response as plaintext in a String regardless of its serialization format.
///
/// # Example