diff --git a/CHANGES.rst b/CHANGES.rst index e0f3983..f7c6fc3 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -12,6 +12,7 @@ Minor changes: - Added additional exception handling of defined errors to fuzzer, to allow fuzzer to explore deeper - Added more instrumentation to fuzz-harness - Rename "contributor" to "collaborator" in documentation +- Correct the outdated "icalendar view myfile.ics" command in documentation. #588 - Update GitHub Actions steps versions Breaking changes: diff --git a/docs/cli.rst b/docs/cli.rst index f86b7f9..941f950 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -9,9 +9,9 @@ option:: view ---- -Use the ``view`` subcommand for a human readable summary of an event:: +To output a human readable summary of an event:: - $ icalendar view myfile.ics + $ icalendar myfile.ics The output will look something like this:: @@ -31,6 +31,6 @@ To use this in terminal based e-mail clients like mutt, add a new mime type (as root):: # cat << EOF > /usr/lib/mime/packages/icalendar - text/calendar; icalendar view '%s'; copiousoutput; description=iCalendar text; priority=2 + text/calendar; icalendar '%s'; copiousoutput; description=iCalendar text; priority=2 EOF # update-mime