nixos/nix
1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-09 03:56:01 +01:00
Code Activity

docs(libstore): document verb() method returns verb root for gerund form

Browse source 
Add documentation to FileTransferRequest::verb() explaining that it returns
a verb root intended to be concatenated with "ing" to form the gerund.
This commit is contained in:
Bernardo Meurer Costa 2025-10-23 20:48:21 +00:00
parent f1968ea38e
commit d924374bf2
No known key found for this signature in database
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/libstore/include/nix/store/filetransfer.hh
View file

@ -135,6 +135,11 @@ struct FileTransferRequest
{ {
} }
/**
* Returns the verb root for logging purposes.
* The returned string is intended to be concatenated with "ing" to form the gerund,
* e.g., "download" + "ing" -> "downloading", "upload" + "ing" -> "uploading".
*/
std::string verb() const std::string verb() const
{ {
switch (method) { switch (method) {