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

[DOCS] Adds note about escaping backslashes in regex #89276

Merged
merged 3 commits into from
Aug 17, 2022

Conversation

abdonpijpelink
Copy link
Contributor

@abdonpijpelink abdonpijpelink commented Aug 11, 2022

The backslash character is an escape character in both JSON strings and regular expressions. This PR adds a note with an example about the need to escape both.

You can preview the change here: https://elasticsearch_89276.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/regexp-syntax.html#regexp-reserved-characters

@abdonpijpelink abdonpijpelink added >docs General docs changes auto-backport-and-merge Automatically create backport pull requests and merge when ready v8.3.4 v8.4.1 labels Aug 11, 2022
@elasticsearchmachine elasticsearchmachine added v8.5.0 Team:Docs Meta label for docs team labels Aug 11, 2022
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

@immavalls immavalls left a comment

Choose a reason for hiding this comment

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

Thanks, @abdonpijpelink, for the fast response. It looks good to me, @crisdarocha might have more feedback as he's been involved in the investigation that led to this

Copy link
Contributor

@crisdarocha crisdarocha left a comment

Choose a reason for hiding this comment

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

I like the change. Example is clear.

Would love to hear what Joe and Tim think about the topic. If this is enough, or if we need to be even more explicit.

@debadair debadair self-requested a review August 16, 2022 15:50
Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for adding this!

@abdonpijpelink abdonpijpelink merged commit f2257ca into elastic:main Aug 17, 2022
abdonpijpelink added a commit to abdonpijpelink/elasticsearch that referenced this pull request Aug 17, 2022
* [DOCS] Adds note about escaping backslashes in regex

* Fix typo

* Simplify example
abdonpijpelink added a commit to abdonpijpelink/elasticsearch that referenced this pull request Aug 17, 2022
* [DOCS] Adds note about escaping backslashes in regex

* Fix typo

* Simplify example
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.3
8.4

elasticsearchmachine pushed a commit that referenced this pull request Aug 17, 2022
* [DOCS] Adds note about escaping backslashes in regex

* Fix typo

* Simplify example
elasticsearchmachine pushed a commit that referenced this pull request Aug 17, 2022
* [DOCS] Adds note about escaping backslashes in regex

* Fix typo

* Simplify example
@mark-vieira mark-vieira added v8.4.0 and removed v8.4.1 labels Aug 24, 2022
@abdonpijpelink abdonpijpelink deleted the backslash-note branch September 15, 2022 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport-and-merge Automatically create backport pull requests and merge when ready >docs General docs changes Team:Docs Meta label for docs team v8.3.4 v8.4.0 v8.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants