Update documentation to reflect offset parameter

instantiator · Oct 22, 2023 · ec89116 · ec89116
1 parent 3a9630c
commit ec89116
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 5 deletions.
diff --git a/docs/post-composition.md b/docs/post-composition.md
@@ -8,23 +8,39 @@ The CLI permits the specification of simple messages, using the `post` verb,
 DistributionCLI post <options>
 ```
 
-The following options are defined for `post`:
+The following options are defined for `post`...
+
+### Provide configuration
 
 ```text
 -c, --config-file           Required. Path to the config file.
--s, --source-file           Path or url to a source file containing posts.
 -f, --filter                Regular expression filter for network short codes.
+```
+
+### Retrieve post content from a [post list format](post-list-format.md) source file
+
+```text
+-s, --source-file           Path or url to a source file containing posts.
+-o, --offset                Offset (index) of a post within the source file. (Leave blank to send all posts in the source file.)
+```
+
+### Fashion a post from command line parameters
+
+```text
 -m, --message               Simple message text.
 -l, --link                  Link for this message.
 -i, --images                URIs to images, semi-colon separated (;)
 -d, --image-descriptions    Image descriptions, semi-colon separated (;)
 -t, --tags                  A list of tags (without # prefix), semi-colon separated (;)
+```
+
+### Application information
+
+```text
 --help                      Display this help screen.
 --version                   Display version information.
 ```
 
-Use the `--message` or `--source-file` option to provide content to post.
-
 ## Source file
 
 To provide a source file with posts, see: [Post list format](post-list-format.md)

diff --git a/open-social-distributor-app/src/DistributionCLI/DistributionCLI.cs b/open-social-distributor-app/src/DistributionCLI/DistributionCLI.cs
@@ -25,7 +25,7 @@ public class PostOptions
         [Option('s', "source-file", Required = false, HelpText = "Path or url to a source file containing posts.")]
         public string? DataPath { get; set; }
 
-        [Option('o', "offset", Required = false, HelpText = "Offset (index) of a post within the source file to use. Leave blank to send all posts in the source file.")]
+        [Option('o', "offset", Required = false, HelpText = "Offset (index) of a post within the source file. (Leave blank to send all posts in the source file.)")]
         public int? Offset { get; set; }
 
         [Option('f', "filter", Required = false, HelpText = "Regular expression filter for network short codes.")]