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

[Site Bug] Issue with the page: /api/latest/compression/add_compression_policy/ #2807

Closed
sdebruyn opened this issue Nov 11, 2023 · 0 comments · Fixed by #2838
Closed

[Site Bug] Issue with the page: /api/latest/compression/add_compression_policy/ #2807

sdebruyn opened this issue Nov 11, 2023 · 0 comments · Fixed by #2838
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@sdebruyn
Copy link
Contributor

Describe the bug

The examples all only have 2 arguments, while the docs say there are a lot more required arguments.

What do the docs say now?

Examples: only required args are name of the table and compress_after
Table with required arguments: more than just these 2

What should the docs say?

Either the examples should have all required arguments, either indicate that the other arguments are optional

Page affected

[Provide the URL to the page you noticed the bug on]

Contributing to documentation

We welcome documentation contributions!

  • For information about how to propose a change, see the contributing guide in our GitHub repository.
  • For information on style and word usage, see the style guide
@sdebruyn sdebruyn added bug Something isn't working documentation Improvements or additions to documentation labels Nov 11, 2023
jamessewell added a commit that referenced this issue Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant