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 type and filter docs for search #1880

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

braingram
Copy link
Contributor

Closes #1879

Description

Update docs to fix arguments for search to use type_ and filter_ instead of the unsupported type and filter.

Tasks

  • run pre-commit on your machine
  • run pytest on your machine
  • Does this PR add new features and / or change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update relevant docstrings and / or docs/ page
    • for any new features, add unit tests
news fragment change types...
  • changes/<PR#>.feature.rst: new feature
  • changes/<PR#>.bugfix.rst: bug fix
  • changes/<PR#>.doc.rst: documentation change
  • changes/<PR#>.removal.rst: deprecation or removal of public API
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change

@braingram braingram marked this pull request as ready for review December 17, 2024 19:40
@braingram braingram requested a review from a team as a code owner December 17, 2024 19:40
@@ -222,8 +222,6 @@ an additional list of class names that previously identified the extension:
Making converted object's contents visible to ``info`` and ``search``
---------------------------------------------------------------------

When an object is converted to YAML, the resulting YAML tree is stored in the
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I noticed this stray sentence fragment and figured I'd stuff that fix into this PR.

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.

Search documentation mentions type and filter not type_ and filter_
1 participant