Skip to content

Commit

Permalink
Docs: Update history.
Browse files Browse the repository at this point in the history
  • Loading branch information
hotoffthehamster committed Apr 15, 2020
1 parent 0ff6900 commit 51c0d8f
Show file tree
Hide file tree
Showing 2 changed files with 236 additions and 1 deletion.
118 changes: 118 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,124 @@ History

.. :changelog:
3.0.6 (2020-04-14)
==================

- Bugfix: Crash handling clock time parse error.
[dob-viewer]

- Usually specifying clock time is okay, e.g., '100' is interpreted
as 1:00a. But the hour and minute components were not being
bounds-checked, i.e., 0..59. So, e.g., trying to decode '090'
would crash (rather than be reported as not-a-date).

- Bugfix: Editor command handlers using stale "now".
[dob-viewer]

- So, e.g., if you started dob at 5p, and now it's 6p, and the current
Fact is active (no end time), pressing 'J' to jump back a day would
find Fact from yesterday at 5p, not 6p. (I'm sure there were more
important use cases where this was more harmful, but this is the
most obvious one to highlight.)

- Bugfix: Relative edit time feature broken/shadowed by delta-time bindings.
[dob-viewer]

- E.g., trying to type a relative time, say '+60', in the edit time widget
was been intercepted by the newish delta-time feature. Consequently, the
delta-time feature is now disabled when editing the start or end time.

- Bugfix: Commando save (``:w``) hides status message ('Saved {} Facts').
[dob-viewer]

- Feature: Jump to date (using ``G`` or ``gg`` command modifier prefix).
[dob-viewer]

- E.g., ``20200410G`` will jump to first Fact on 2020-04-10.

- User can specify (via config) allowable punctuation.

- E.g., in addition to ``20200101G`` to jump to New Year's day, user
can instead type ``2020-01-01G``, or ``2020/01/01G``, etc., depending
on what ``date_separators`` are specified in the config.

- More examples: ``100G`` jumps to Fact at 1:00 AM today.

Or type ``2020/01/01 1400G`` or more simply ``2020010114G``
to jump to 2p on New Year's day, 2020.

- Feature: Wire backspace to command modifier, commando, and time-delta modes.
[dob-viewer]

- Pressing backspace will (naturally) remove the last character typed
from the command modifier/commando/time-delta being built, or it'll
cancel the operation if nothing is left to remove.

- Feature: Add true first/final Fact jump commands.
[dob-viewer]

- Because ``G`` and ``gg`` stop on FactsManager group boundaries
(these are the contiguous Fact "windows" the editor uses to
store Facts in memory (which allows editing multiple Facts
between database writes), and are used during the import process,
which is really where stopping on group boundaries makes the most
sense. In other words, we should probably make these commands the
new ``G``/``gg``, and move the old commands to other key mappings.
But I'm not ready to make that... leap).

- The new commands are wired to ``f`` (final) and ``F`` (first) Fact jump.

- Improve: Show command modifier or delta-time in status as user types.
[dob-viewer]

- Might as well, because we already display the commando as it's built.
And it provides context to the user, which could be a teachable moment,
if the user is learning by mashing (keys).

- Improve: Support allow-gap toggling.
[dob-viewer]

- Now that the command modifier or time-delta is shown as a status
message, it'll be obvious to the user if allow-gap is on or off.
So pressing ``!!`` will first enable allow-gap, then disable it,
rather than canceling the operation.

- Improve: Let user allow-gap (e.g., ``!``) before time-delta (``-``/``+``).
[dob-viewer]

- E.g., in addition to ``+10!<ENTER>``, ``!+10<ENTER>`` also now works.

- Improve: Wire Ctrl-C to clear or cancel command modifier/commando/delta-time.
[dob-viewer]

- Improve: Allow Tab, in addition to Enter, to finish delta-time command.
[dob-viewer]

- Because Tab is the left hand's Enter.

- Improve: Make easy to set end to "now" on active Fact (e.g., via ``[`` or ``]``).
[dob-viewer]

- For active Fact, rather than the 1-minute decrement (``[``) and increment
(``]``) operators using (now - 60 seconds) or (now + 60 seconds), just use
now. (So if user wants to really remove 1 minute from now they can just
press the key twice, e.g., ``[[``, or use a count modifier, e.g., ``1[``.)

- Improve: Linger to show 'Saved' message on save-and-exit commando (``:wq``).
[dob-viewer]

- Improve: Pass carousel-active indicator to post processors.
[dob-viewer]

- So that plugins may behave differently when triggered by a save when dob
is also quitting, versus a save from the interactive editor.

- This is mostly useful so that a plugin does not errantly output any
text to the display, which would mess up the editor interface.

- Improve: Add "from" to Jump Fact time reference status message, for context.
[dob-viewer]

3.0.5 (2020-04-13)
==================

Expand Down
119 changes: 118 additions & 1 deletion docs/history-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
[OhMyRepos]: https://github.com/landonb/ohmyrepos
"OhMyRepos"

## 3.0.5 (2020-04-13)
## 3.0.6 (2020-04-13)

[dob]: https://github.com/hotoffthehamster/dob
"`dob`"
Expand All @@ -28,6 +28,123 @@
[dob-viewer]: https://github.com/hotoffthehamster/dob-viewer
"`dob-viewer`"

- Bugfix: Crash handling clock time parse error.
[[dob-viewer][]]

- Usually specifying clock time is okay, e.g., '100' is interpreted
as 1:00a. But the hour and minute components were not being
bounds-checked, i.e., 0..59. So, e.g., trying to decode '090'
would crash (rather than be reported as not-a-date).

- Bugfix: Editor command handlers using stale "now".
[[dob-viewer][]]

- So, e.g., if you started dob at 5p, and now it's 6p, and the current
Fact is active (no end time), pressing 'J' to jump back a day would
find Fact from yesterday at 5p, not 6p. (I'm sure there were more
important use cases where this was more harmful, but this is the
most obvious one to highlight.)

- Bugfix: Relative edit time feature broken/shadowed by delta-time bindings.
[[dob-viewer][]]

- E.g., trying to type a relative time, say '+60', in the edit time widget
was been intercepted by the newish delta-time feature. Consequently, the
delta-time feature is now disabled when editing the start or end time.

- Bugfix: Commando save (`:w`) hides status message ('Saved {} Facts').
[[dob-viewer][]]

- Feature: Jump to date (using `G` or `gg` command modifier prefix).
[[dob-viewer][]]

- E.g., `20200410G` will jump to first Fact on 2020-04-10.

- User can specify (via config) allowable punctuation.

- E.g., in addition to `20200101G` to jump to New Year's day, user
can instead type `2020-01-01G`, or `2020/01/01G`, etc., depending
on what `date_separators` are specified in the config.

- More examples: `100G` jumps to Fact at 1:00 AM today.

Or type `2020/01/01 1400G` or more simply `2020010114G`
to jump to 2p on New Year's day, 2020.

- Feature: Wire backspace to command modifier, commando, and time-delta modes.
[[dob-viewer][]]

- Pressing backspace will (naturally) remove the last character typed
from the command modifier/commando/time-delta being built, or it'll
cancel the operation if nothing is left to remove.

- Feature: Add true first/final Fact jump commands.
[[dob-viewer][]]

- Because `G` and `gg` stop on FactsManager group boundaries
(these are the contiguous Fact "windows" the editor uses to
store Facts in memory (which allows editing multiple Facts
between database writes), and are used during the import process,
which is really where stopping on group boundaries makes the most
sense. In other words, we should probably make these commands the
new `G`/`gg`, and move the old commands to other key mappings.
But I'm not ready to make that... leap).

- The new commands are wired to `f` (final) and `F` (first) Fact jump.

- Improve: Show command modifier or delta-time in status as user types.
[[dob-viewer][]]

- Might as well, because we already display the commando as it's built.
And it provides context to the user, which could be a teachable moment,
if the user is learning by mashing (keys).

- Improve: Support allow-gap toggling.
[[dob-viewer][]]

- Now that the command modifier or time-delta is shown as a status
message, it'll be obvious to the user if allow-gap is on or off.
So pressing `!!` will first enable allow-gap, then disable it,
rather than canceling the operation.

- Improve: Let user allow-gap (e.g., `!`) before time-delta (`-`/`+`).
[[dob-viewer][]]

- E.g., in addition to `+10!<ENTER>`, `!+10<ENTER>` also now works.

- Improve: Wire Ctrl-C to clear or cancel command modifier/commando/delta-time.
[[dob-viewer][]]

- Improve: Allow Tab, in addition to Enter, to finish delta-time command.
[[dob-viewer][]]

- Because Tab is the left hand's Enter.

- Improve: Make easy to set end to "now" on active Fact (e.g., via `[` or `]`).
[[dob-viewer][]]

- For active Fact, rather than the 1-minute decrement (`[`) and increment
(`]`) operators using (now - 60 seconds) or (now + 60 seconds), just use
now. (So if user wants to really remove 1 minute from now they can just
press the key twice, e.g., `[[`, or use a count modifier, e.g., `1[`.)

- Improve: Linger to show 'Saved' message on save-and-exit commando (`:wq`).
[[dob-viewer][]]

- Improve: Pass carousel-active indicator to post processors.
[[dob-viewer][]]

- So that plugins may behave differently when triggered by a save when dob
is also quitting, versus a save from the interactive editor.

- This is mostly useful so that a plugin does not errantly output any
text to the display, which would mess up the editor interface.

- Improve: Add "from" to Jump Fact time reference status message, for context.
[[dob-viewer][]]

## 3.0.5 (2020-04-13)

- Improve: Alias command `env` to `environs`. [[dob][]]

- E.g., `dob env`.
Expand Down

0 comments on commit 51c0d8f

Please sign in to comment.