Merge pull request #2256 from saulpw/v3.0.2

V3.0.2 release branch
saulpw · Jan 16, 2024 · 42c2bbc · 42c2bbc
2 parents e492f83 + 16921b8
commit 42c2bbc
Show file tree

Hide file tree

Showing 27 changed files with 481 additions and 74 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # VisiData version history
 
+# v3.0.2 (2024-01-15)
+
+### Fixes and minor improvements
+
+- [cli] add `--guides` to open the guide index
+- [cmdpalette] only first 10 suggestions should have shortcut keys  #2242
+- [draw] use default bg on col hdr sep
+- [input] draw help sidebar on top of sheet/updater  #2241
+- [graph] sort by x and y columns when diving (PR by @midichef #2226)
+- [guides] improve formatting of command and options in sidebar + guides
+- [replay] stop stderr batch progress when entering interactive mode  #2251
+- [shell] clean up DirSheet sidebar
+- [sidebar] grab user's keystroke of sidebar-toggle for helpstring  #2250
+- [sort] a better fix for maintaining sort ordering on sheet copies  #2190 #2254
+- [tests] add "test" extras for installing PyPI packages needed to run tests
+
 # v3.0.1 (2024-01-07)
 
 ### Fixes and minor improvements

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# VisiData v3.0.1
+# VisiData v3.0.2
 
 [![Tests](https://github.com/saulpw/visidata/workflows/visidata-ci-build/badge.svg)](https://github.com/saulpw/visidata/actions/workflows/main.yml)
 [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/saulpw/visidata)

diff --git a/docs/man.md b/docs/man.md
@@ -432,6 +432,7 @@ vd(1)
      <span style="font-weight:bold;">-P</span>=<span style="text-decoration:underline;">longname</span>                  preplay <span style="text-decoration:underline;">longname</span> before replay or regular launch; limited to <span style="font-weight:bold;">Base</span> <span style="font-weight:bold;">Sheet</span> bound commands
      <span style="font-weight:bold;">+</span><span style="text-decoration:underline;">toplevel</span>:<span style="text-decoration:underline;">subsheet</span>:<span style="text-decoration:underline;">col</span>:<span style="text-decoration:underline;">row</span>   launch vd with <span style="text-decoration:underline;">subsheet</span> of <span style="text-decoration:underline;">toplevel</span> at top-of-stack, and cursor at <span style="text-decoration:underline;">col</span> and <span style="text-decoration:underline;">row</span>; all arguments are optional
      <span style="font-weight:bold;">--overwrite</span>=<span style="text-decoration:underline;">c</span>                Overwrite with confirmation
+     <span style="font-weight:bold;">--guides</span>                     open Guide Index
 
      <span style="font-weight:bold;">-f</span>, <span style="font-weight:bold;">--filetype</span>=<span style="text-decoration:underline;">filetype</span>      tsv                set loader to use for <span style="text-decoration:underline;">filetype</span> instead of file extension
      <span style="font-weight:bold;">-d</span>, <span style="font-weight:bold;">--delimiter</span>=<span style="text-decoration:underline;">delimiter</span>    \t                 field delimiter to use for tsv/usv filetype
@@ -516,7 +517,7 @@ vd(1)
      <span style="font-weight:bold;">--matrix-device-id</span>=<span style="text-decoration:underline;">str</span>       VisiData           device ID associated with matrix login
      <span style="font-weight:bold;">--reddit-client-id</span>=<span style="text-decoration:underline;">str</span>                          client_id for reddit api
      <span style="font-weight:bold;">--reddit-client-secret</span>=<span style="text-decoration:underline;">str</span>                      client_secret for reddit api
-     <span style="font-weight:bold;">--reddit-user-agent</span>=<span style="text-decoration:underline;">str</span>      3.0.1              user_agent for reddit api
+     <span style="font-weight:bold;">--reddit-user-agent</span>=<span style="text-decoration:underline;">str</span>      3.0.2              user_agent for reddit api
      <span style="font-weight:bold;">--zulip-batch-size</span>=<span style="text-decoration:underline;">int</span>       -100               number of messages to fetch per call (&lt;0 to fetch before anchor)
      <span style="font-weight:bold;">--zulip-anchor</span>=<span style="text-decoration:underline;">int</span>           1000000000         message id to start fetching from
      <span style="font-weight:bold;">--zulip-delay-s</span>=<span style="text-decoration:underline;">float</span>        1e-05              seconds to wait between calls (0 to stop after first)
@@ -788,5 +789,5 @@ vd(1)
 <span style="font-weight:bold;">AUTHOR</span>
      <span style="font-weight:bold;">VisiData</span> was made by Saul Pwanson &lt;<span style="text-decoration:underline;">vd@saul.pw</span>&gt;.
 
-Linux/MacOS                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     January 7, 2024                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Linux/MacOS
+Linux/MacOS                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     January 15, 2024                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Linux/MacOS
 </pre></section>
diff --git a/docs/test.md b/docs/test.md
@@ -2,15 +2,23 @@
 eleventyNavigation:
     key: Contributing Tests
     order: 99
-Update: 2018-01-28
-Version: VisiData 1.0
+Update: 2024-01-10
+Version: VisiData 3.0
 ---
 
 
 The `tests` folder contains functional tests in the form of `.vd` scripts, each of which records a session of VisiData commands.  These ensure that data processing works consistently and reliably.
 
 `dev/test.sh` (run from the git root) will execute all tests.  The final sheet of each test is saved as .tsv and compared to the respective expected output checked into the `tests/golden` directory.
 
+As of January 2024, to pass all the tests, you will need to install the `test` extras:
+
+```
+git clone https://github.com/saulpw/visidata.git
+cd visidata
+pip3 install ".[test]"
+```
+
 To show each step of a test with a delay of 1 second between commands:
 
     $ bin/vd -p tests/foo.vd -w 1
@@ -27,4 +35,11 @@ To build a `.vd` file:
 
     Press `Shift+D` to open the `commanDlog Sheet`, and press `Ctrl+S` to save it with a `.vd` suffix.
 
+
+There are also unit tests in visidata/tests. To run the unit tests:
+
+```
+pytest -sv visidata/tests
+```
+
 ---