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

Fix Filter Docs #714

Merged
merged 3 commits into from
Aug 22, 2024
Merged

Fix Filter Docs #714

merged 3 commits into from
Aug 22, 2024

Conversation

czaloom
Copy link
Collaborator

@czaloom czaloom commented Aug 21, 2024

Changes

  • Added docstrings.
  • Overhauled docs organization.
  • Added filter-related docs.

@czaloom czaloom added the documentation Improvements or additions to documentation label Aug 21, 2024
@czaloom czaloom self-assigned this Aug 21, 2024
@czaloom czaloom linked an issue Aug 21, 2024 that may be closed by this pull request
1 task
@czaloom czaloom marked this pull request as ready for review August 21, 2024 19:53
@czaloom czaloom requested review from ntlind and ekorman as code owners August 21, 2024 19:53
@@ -0,0 +1,16 @@
::: valor.schemas.Gte
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could all of the "Conditions" exist on one page, and all of the "Logic" on another, rather than having a separate page for each individual class? in this setup, it seems like it would take a lot of clicking between pages for a user to figure out what to use. some of the docs for these classes (like most of the "Conditions") are also very barebones, so it seems odd to break them out separately

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

I think this leads to a confusing docs layout. Do you have any suggestions on how to improve this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that format is visually confusing, but it's weird that you're mixing operators (Gt, Gte, etc.) with other stuff (Condition, Function) under a header called "Operators". maybe move these latter two docstrings into Filter or another category?

@czaloom czaloom merged commit ab45038 into main Aug 22, 2024
12 checks passed
@czaloom czaloom deleted the 713-bug-filters-documentation-not-rendering branch August 22, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG: Filters Documentation not Rendering
2 participants