subplotlib: Add some basic docs to a bit of the files steplibrary

Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>

1 files changed, 20 insertions, 0 deletions

diff --git a/subplotlib/src/steplibrary/files.rs b/subplotlib/src/steplibrary/files.rs
index 169111d..35f841a 100644
--- a/subplotlib/src/steplibrary/files.rs
+++ b/subplotlib/src/steplibrary/files.rs
@@ -19,6 +19,13 @@ pub use crate::prelude::*;
 pub use super::datadir::Datadir;
 
 #[derive(Default)]
+/// Context data for the `files` step library
+///
+/// This context contains a mapping from filename to metadata so that
+/// the various steps remember metadata and then query it later can find it.
+///
+/// This context depends on, and will automatically register, the context for
+/// the [`datadir`][crate::steplibrary::datadir] step library.
 pub struct Files {
     metadata: HashMap<String, Metadata>,
 }
@@ -29,6 +36,13 @@ impl ContextElement for Files {
     }
 }
 
+/// Create a file on disk from an embedded file
+///
+/// # `given file {embedded_file}`
+///
+/// Create a file in the data dir from an embedded file.
+///
+/// This defers to [`create_from_embedded_with_other_name`]
 #[step]
 #[context(Datadir)]
 pub fn create_from_embedded(context: &ScenarioContext, embedded_file: SubplotDataFile) {
@@ -36,6 +50,12 @@ pub fn create_from_embedded(context: &ScenarioContext, embedded_file: SubplotDat
     create_from_embedded_with_other_name::call(context, &filename_on_disk, embedded_file)
 }
 
+/// Create a file on disk from an embedded file with a given name
+///
+/// # `given file {filename_on_disk} from {embedded_file}`
+///
+/// Creates a file in the data dir from an embedded file, but giving it a
+/// potentially different name.
 #[step]
 pub fn create_from_embedded_with_other_name(
     context: &Datadir,