Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document lake output format and add/update ls docs #5187

Merged
merged 1 commit into from
Jul 25, 2024

Conversation

philrz
Copy link
Contributor

@philrz philrz commented Jul 19, 2024

What's Changing

  • The -f lake output format is documented
  • Docs are added for zed ls
  • Command help docs are updated for zed ls

Why

When creating the "output formats" table in #5170, I spotted lake as one of the output formats available via -f in the zq -h help text. I wasn't previously familiar with it, but I asked around to get consensus on whether it should be documented or hidden. @mccanne ultimately was slightly in favor of documenting it, so that's the main thing I set out to do here.

Details

Once I got started, I realized I wanted to hyperlink to docs about the zed ls command and only then noticed we didn't have a section in the zed command doc about it, so I went to add one based on the current zed ls -h command help text. However, that help text seemed somewhat out-of-sync with its current behavior, so I corrected that as well.

Closes #5169

@philrz philrz requested a review from a team July 19, 2024 21:25
@philrz philrz self-assigned this Jul 19, 2024
@philrz philrz merged commit f3eefd8 into main Jul 25, 2024
4 checks passed
@philrz philrz deleted the doc-lake-output-format branch July 25, 2024 05:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document or hide/remove "-f lake" output option
2 participants