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

Make FilePatternMatcher.with_repr private and update docs #2747

Merged
merged 1 commit into from
Jan 10, 2025

Conversation

kramstrom
Copy link
Contributor

@kramstrom kramstrom commented Jan 10, 2025

Describe your changes

  • The current docs unfortunately show with_repr as the first method which should be private and is not useful for users. - Moved the documentation from the __call__ method to the class directly as it doesn't show up in the docs and isn't used directly.
  • Added a from_file example
Screenshot 2025-01-10 at 16 08 08
  • Provide Linear issue reference (e.g. MOD-1234) if available.
Backward/forward compatibility checks

Check these boxes or delete any item (or this section) if not relevant for this PR.

  • Client+Server: this change is compatible with old servers
  • Client forward compatibility: this change ensures client can accept data intended for later versions of itself

Note on protobuf: protobuf message changes in one place may have impact to
multiple entities (client, server, worker, database). See points above.


Changelog

@kramstrom kramstrom requested a review from freider January 10, 2025 15:00
Copy link
Contributor

@freider freider left a comment

Choose a reason for hiding this comment

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

thanks for fixing!

@kramstrom kramstrom merged commit 8504d66 into main Jan 10, 2025
23 checks passed
@kramstrom kramstrom deleted the kramstrom/filepatternmatcher-cleanup branch January 10, 2025 15:16
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.

2 participants