Skip to content

Editing DSU Entries

Gene M. Angelo, Jr edited this page Jan 6, 2024 · 7 revisions

You can edit DSU entry groups by date. dsu will allow you to edit a DSU entry group using the dsu edit SUBCOMMAND date (n|today|t|tomorrow|y|yesterday|date DATE) you specify. dsu edit will open your DSU entry group entries in your editor, where you'll be able to perform editing functions against one or all of the entries. See "Customizing the dsu configuration file" in order to configure dsu to use the editor of your choice, in order to make editing more convenient.

If no entries exist for the DSU date, the editor will open and allow you to add entries for that date. If you have the :carry_over_entries_to_today configuration option setting set to true, entries from the last DSU date will be copied into the editor for your convenience. Understand that duplicate entries are not allowed; that is, the entry DESCRIPTION must be unique within an entry group (date), so non-unique entries will not be saved. The same holds true for entries that do not pass validation (DESCRIPTION must be between 2 and 256 characters (inclusive) in length).

  • $ dsu edit today
  • $ dsu e n # Equivalent to the above, only using shortcuts
  • $ dsu edit tomorrow
  • $ dsu e t # Equivalent to the above, only using shortcuts
  • $ dsu edit yesterday
  • $ dsu e y # Equivalent to the above, only using shortcuts
  • $ dsu edit date DATE
  • $ dsu e d DATE # Equivalent to the above, only using shortcuts

Examples

The following will edit your DSU entry group entries for "Today", where Time.now == '2023-05-09 12:13:45.8273 -0400'. Simply follow the directions in the editor file, then save and close your editor to apply the changes:

dsu edit today
dsu e n # Equivalent to the above, only using shortcuts
#=> In your editor, you will see...
################################################################################
## Editing DSU Entries for Tuesday, (Today) 2023-05-23 EDT
################################################################################

################################################################################
## DSU ENTRIES
################################################################################

Interactive planning meeting 11:00AM.
Pair with Chad on ticket 31211.
Investigate spike ticket 31255.
Review Kelsey's PR ticket 30721.

################################################################################
## INSTRUCTIONS
################################################################################
##    ADD a DSU entry: type an ENTRY DESCRIPTION on a new line.
##   EDIT a DSU entry: change the existing ENTRY DESCRIPTION.
## DELETE a DSU entry: delete the ENTRY DESCRIPTION.
##  NOTE: deleting all of the ENTRY DESCRIPTIONs will delete the entry group file;
##        this is preferable if this is what you want to do :)
## REORDER a DSU entry: reorder the ENTRY DESCRIPTIONs in order preference.
##
## *** When you are done, save and close your editor ***
################################################################################

Edit an Entry

Simply change the entry descripton text.

For example...

from: Interative planning meeting 11:00AM.
  to: Interative planning meeting 12:00AM.

Add an Entry

Simply type a new entry on a separate line.

For example...

Add me to this entry group.

NOTE: Any entry that starts with a # in the first character position will be ignored.*

Delete an Entry

Simply delete the entry.

For example...

## Delete this entry from the editor file
from: Interative planning meeting 11:00AM.
  to: <deleted>

Reorder Entries

Simply reorder the entries in the editor.

For example...

from: Interative planning meeting 11:00AM.
      Pair with Chad on ticket 31211.
      Investigate spike ticket 31255.
      Review Kelsey's PR ticket 30721.
  to: Review Kelsey's PR ticket 30721.
      Investigate spike ticket 31255.
      Pair with Chad on ticket 31211.
      Interactive planning meeting 11:00AM.