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

Add safer path operators and improve documentation #667

Merged
merged 1 commit into from
Mar 12, 2025

Conversation

satabin
Copy link
Member

@satabin satabin commented Mar 11, 2025

The documentation now does not bring the unsafe raw operators first, and explains better what are the existing operators and what to be careful about.

This also adds a new through operator, that allows for streaming handling of path matches.

This PR is a follow-up on the discussion from #666 (cc @mrdziuban)

@satabin satabin added documentation Improvements or additions to documentation json xml labels Mar 11, 2025
@satabin satabin requested a review from a team as a code owner March 11, 2025 18:32
@satabin satabin added this to the 1.12.0 milestone Mar 11, 2025
The documentation now does not bring the unsafe `raw` operators first,
and explains better what are the existing operators and what to be
careful about.

This also adds a new `through` operator, that allows for streaming
handling of path matches.
@satabin satabin force-pushed the documentation/xpath-safer branch from 0a89bb3 to 0f62f1b Compare March 11, 2025 18:43
Copy link
Collaborator

@ybasket ybasket left a comment

Choose a reason for hiding this comment

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

Changes look good.

I'm mildly unhappy with the naming of through as fs2 already uses that name for something similar, yet not equal and you get through(filter.through(...)). But I have no convincing alternative suggestion, toPipe and funnel both aren't really better. So if you have another good name, let's change it, otherwise merge as-is.

@satabin
Copy link
Member Author

satabin commented Mar 12, 2025

Changes look good.

I'm mildly unhappy with the naming of through as fs2 already uses that name for something similar, yet not equal and you get through(filter.through(...)). But I have no convincing alternative suggestion, toPipe and funnel both aren't really better. So if you have another good name, let's change it, otherwise merge as-is.

I kind of chose through on purpose, as it sends things to a Pipe, and this is how fs2 calls the action. I will merge and see if I can find something else before releasing.

@satabin satabin merged commit 8a87021 into main Mar 12, 2025
27 checks passed
@satabin satabin deleted the documentation/xpath-safer branch March 12, 2025 21:39
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 json xml
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants