GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-07-07 20:06:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

fix confusing doc string

Browse source
This commit is contained in:
Dustin J. Mitchell 2022-01-26 00:36:33 +00:00
parent c5ff2398f7
commit f8cffb798c
2 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lib/src/string.rs
View file

@ -92,9 +92,10 @@ impl<'a> From<&str> for TCString<'a> {
/// Create a new TCString referencing the given C string. The C string must remain valid until
/// after the TCString is freed. It's typically easiest to ensure this by using a static string.
///
/// NOTE: this function does _not_ take responsibility for freeing the C string itself.
/// The underlying string once the TCString has been freed. Among other times, TCStrings are
/// freed when they are passed to API functions (unless documented otherwise). For example:
/// NOTE: this function does _not_ take responsibility for freeing the C string itself. The
/// underlying string can be freed once the TCString referencing it has been freed.
///
/// For example:
///
/// ```
/// char *url = get_item_url(..); // dynamically allocate C string

7
lib/taskchampion.h
View file

@ -117,9 +117,10 @@ void tc_replica_free(struct TCReplica *rep);
* Create a new TCString referencing the given C string. The C string must remain valid until
* after the TCString is freed. It's typically easiest to ensure this by using a static string.
*
* NOTE: this function does _not_ take responsibility for freeing the C string itself.
* The underlying string once the TCString has been freed. Among other times, TCStrings are
* freed when they are passed to API functions (unless documented otherwise). For example:
* NOTE: this function does _not_ take responsibility for freeing the C string itself. The
* underlying string can be freed once the TCString referencing it has been freed.
*
* For example:
*
* ```
* char *url = get_item_url(..); // dynamically allocate C string