diff options
| author | Ryan Lahfa <tvl@lahfa.xyz> | 2024-01-05T23·39+0100 |
|---|---|---|
| committer | raitobezarius <tvl@lahfa.xyz> | 2024-01-06T01·39+0000 |
| commit | cbcd078684d1cdd279aefb8ab25aff0d8d180d6c (patch) | |
| tree | 39bd756a4caf0bb7d7b4f5ec8bc1e53f58e772a6 | |
| parent | 00aa3260c91b946736179133f353009cab7b9d35 (diff) | |
chore(tvix/castore): fix the docstring for `process_entry` r/7354
It was a `//` not a `///`. Change-Id: Iee3e8c116d73b5dd8a41c027153714415a66695f Reviewed-on: https://cl.tvl.fyi/c/depot/+/10566 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de>
| -rw-r--r-- | tvix/castore/src/import.rs | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/tvix/castore/src/import.rs b/tvix/castore/src/import.rs index 4545f35fc319..c4d410497235 100644 --- a/tvix/castore/src/import.rs +++ b/tvix/castore/src/import.rs @@ -45,21 +45,21 @@ impl From<CastoreError> for Error { } } -// This processes a given [walkdir::DirEntry] and returns a -// proto::node::Node, depending on the type of the entry. -// -// If the entry is a file, its contents are uploaded. -// If the entry is a directory, the Directory is uploaded as well. -// For this to work, it relies on the caller to provide the directory object -// with the previously returned (child) nodes. -// -// It assumes entries to be returned in "contents first" order, means this -// will only be called with a directory if all children of it have been -// visited. If the entry is indeed a directory, it'll also upload that -// directory to the store. For this, the so-far-assembled Directory object for -// this path needs to be passed in. -// -// It assumes the caller adds returned nodes to the directories it assembles. +/// This processes a given [walkdir::DirEntry] and returns a +/// proto::node::Node, depending on the type of the entry. +/// +/// If the entry is a file, its contents are uploaded. +/// If the entry is a directory, the Directory is uploaded as well. +/// For this to work, it relies on the caller to provide the directory object +/// with the previously returned (child) nodes. +/// +/// It assumes entries to be returned in "contents first" order, means this +/// will only be called with a directory if all children of it have been +/// visited. If the entry is indeed a directory, it'll also upload that +/// directory to the store. For this, the so-far-assembled Directory object for +/// this path needs to be passed in. +/// +/// It assumes the caller adds returned nodes to the directories it assembles. #[instrument(skip_all, fields(entry.file_type=?&entry.file_type(),entry.path=?entry.path()))] async fn process_entry<'a, BS>( blob_service: BS, |