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

{} are not brackets #2114

Closed
AlexDaniel opened this issue Jun 22, 2018 · 6 comments
Closed

{} are not brackets #2114

AlexDaniel opened this issue Jun 22, 2018 · 6 comments
Assignees
Labels
bug Error of some kind, from a typo to errors in the examples. docs Documentation issue (primary issue type) xt Regarding current or new xt/ tests or the utils/

Comments

@AlexDaniel
Copy link
Member

AlexDaniel commented Jun 22, 2018

See http://colabti.org/irclogger/irclogger_log/perl6?date=2018-06-22#l377

We should make sure we are not referring to {} as “brackets”, and maybe we can even add a test to guarantee that this doesn't happen in the future.

@AlexDaniel AlexDaniel added the xt Regarding current or new xt/ tests or the utils/ label Jun 22, 2018
@AlexDaniel
Copy link
Member Author

See irc discussion linked above. To avoid confusion it should always be “curly braces” and “square brackets” which is unambiguous.

@AlexDaniel AlexDaniel added meta RFCs, general discussion, writing style, repository organization, etc. docs Documentation issue (primary issue type) and removed meta RFCs, general discussion, writing style, repository organization, etc. labels Jun 22, 2018
@JJ JJ added the bug Error of some kind, from a typo to errors in the examples. label Jun 22, 2018
@JJ
Copy link
Contributor

JJ commented Jun 22, 2018

So the xt would check whether brackets is preceded by curly?

@AlexDaniel
Copy link
Member Author

AlexDaniel commented Jun 22, 2018

Yes, something like:

  • braces are always “curly braces”
  • brackets are either “angle brackets” or “square brackets”

@JJ JJ closed this as completed in 849f90c Jun 23, 2018
@JJ JJ reopened this Jun 23, 2018
JJ added a commit that referenced this issue Jun 24, 2018
JJ added a commit that referenced this issue Jun 24, 2018
JJ added a commit that referenced this issue Jun 24, 2018
JJ added a commit that referenced this issue Jun 24, 2018
JJ added a commit that referenced this issue Jun 24, 2018
JJ added a commit that referenced this issue Jun 24, 2018
I don't know, however, about closing the issue #2114. Several problems

* We need a generic name that includes parentheses/braces/brackets
* Do we need/want the test? It might include some verbosity
* Sometimes parentheses (plural) is spelled parenthesis (singular).
@coke coke self-assigned this Nov 27, 2018
coke added a commit that referenced this issue Nov 27, 2018
@coke
Copy link
Collaborator

coke commented Nov 27, 2018

Test added in xt/braces.t. It's failing, with the following errors:

not ok 7 - doc/Language/101-basics.pod6: Found 'brackets' without 'square'
not ok 10 - doc/Language/5to6-perlfunc.pod6: Found 'brackets' without 'square'
not ok 27 - doc/Language/glossary.pod6: Found 'brackets' without 'square'
not ok 38 - doc/Language/list.pod6: Found 'brackets' without 'square'
not ok 48 - doc/Language/numerics.pod6: Found 'brackets' without 'square'
not ok 50 - doc/Language/operators.pod6: Found 'braces' without 'curly'.
not ok 55 - doc/Language/pod.pod6: Found 'brackets' without 'square'
not ok 57 - doc/Language/py-nutshell.pod6: Found 'braces' without 'curly'.
not ok 58 - doc/Language/quoting.pod6: Found 'brackets' without 'square'
not ok 59 - doc/Language/rb-nutshell.pod6: Found 'brackets' without 'square'
not ok 61 - doc/Language/regexes.pod6: Found 'brackets' without 'square'
not ok 64 - doc/Language/structures.pod6: Found 'brackets' without 'square'
not ok 66 - doc/Language/syntax.pod6: Found 'brackets' without 'square'

There is currently no exception mechanism; if one is needed, let me know.

@coke
Copy link
Collaborator

coke commented Dec 5, 2018

Down to:

not ok 27 - doc/Language/glossary.pod6: Found 'brackets' without 'square' or 'angle'.
not ok 55 - doc/Language/pod.pod6: Found 'brackets' without 'square' or 'angle'.
not ok 61 - doc/Language/regexes.pod6: Found 'brackets' without 'square' or 'angle'.
not ok 66 - doc/Language/syntax.pod6: Found 'Brackets' without 'square' or 'angle'.

These need to be reviewed; possible outcomes: add one of the words, rework to avoid the problem, or note that the text is correct as is and the test needs an exception/change. Looks like we could benefit from a word choice that means "any bracket or brace"

@JJ
Copy link
Contributor

JJ commented May 9, 2019

27 ✔️
55 ✔️
61 ✔️
66 ✔️

JJ added a commit that referenced this issue May 9, 2019
JJ added a commit that referenced this issue May 9, 2019
JJ added a commit that referenced this issue May 9, 2019
@JJ JJ closed this as completed in a394425 May 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Error of some kind, from a typo to errors in the examples. docs Documentation issue (primary issue type) xt Regarding current or new xt/ tests or the utils/
Projects
None yet
Development

No branches or pull requests

3 participants