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

clarify filter usage #1944

Merged
merged 1 commit into from
Jul 14, 2019
Merged

clarify filter usage #1944

merged 1 commit into from
Jul 14, 2019

Conversation

tessus
Copy link
Contributor

@tessus tessus commented Jul 9, 2019

The current paragraph is not complete, since a digit is not a special character.

Changing it to:

If the key contains special characters or starts with a digit,
you need to surround it with double quotes like this:
`."foo$"`, or else `.["foo$"]`.

The current paragraph is not complete, since a digit is not a special character.

Changing it to:

    If the key contains special characters or starts with a digit,
    you need to surround it with double quotes like this:
    `."foo$"`, or else `.["foo$"]`.
@tessus
Copy link
Contributor Author

tessus commented Jul 9, 2019

/ref #1943

@coveralls
Copy link

Coverage Status

Coverage increased (+0.03%) to 85.112% when pulling 8d9817d on tessus:doc-improvement into e944fe8 on stedolan:master.

@wtlangford
Copy link
Contributor

This looks great, thanks! Should we also demonstrate a version like ."2foo" for extra clarity?

@tessus
Copy link
Contributor Author

tessus commented Jul 9, 2019

IMO there's no need, and I wouldn't even know where to add it and how.

It would make it more complex and confusing. Since you've already used both forms, you'd have to use both for the 2nd example as well:

e.g.:

`."foo$"` or `.["foo$"]`, and `."2foo"` or `.["2foo"]`

For me this makes it less readable, but maybe that's just me.

@tessus
Copy link
Contributor Author

tessus commented Jul 13, 2019

@wtlangford is antthing else blocking this from being merged?

@wtlangford
Copy link
Contributor

Nope, I was just busy. Thanks!

@wtlangford wtlangford merged commit a976387 into jqlang:master Jul 14, 2019
@tessus
Copy link
Contributor Author

tessus commented Jul 14, 2019

Thanks.

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.

None yet

3 participants