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

Exception message doesn't follow doc style guide #2672

Open
coke opened this issue Feb 4, 2019 · 2 comments
Open

Exception message doesn't follow doc style guide #2672

coke opened this issue Feb 4, 2019 · 2 comments

Comments

@coke
Copy link
Collaborator

coke commented Feb 4, 2019

The Problem

my class X::Syntax::Comment::Embedded does X::Syntax {
    method message() { "Opening bracket required for #` comment" }
}

the perl6/doc styleguide requires that we use "curly brace" here instead of bracket, and we have a currently failing test:

$ xt/braces.t doc/Type/X/Syntax/Comment/Embedded.pod6
1..1
not ok 1 - doc/Type/X/Syntax/Comment/Embedded.pod6: Found 'bracket' without 'square' or 'angle'.
# Failed test 'doc/Type/X/Syntax/Comment/Embedded.pod6: Found 'bracket' without 'square' or 'angle'.'
# at xt/braces.t line 37
# Looks like you failed 1 test of 1

While not a must have, I think following the doc style guide for this exception is correct (and then we can update the text in the doc site and then pass the test)

@coke coke changed the title Error message doesn't follow doc style guide Exception message doesn't follow doc style guide Feb 4, 2019
@jnthn jnthn added good first issue This issue is likely easy for beginners to resolve easy to resolve This issue is likely easy for beginners to resolve labels Feb 7, 2019
@AlexDaniel AlexDaniel removed easy to resolve This issue is likely easy for beginners to resolve good first issue This issue is likely easy for beginners to resolve labels Mar 12, 2019
@AlexDaniel
Copy link
Contributor

AlexDaniel commented Mar 12, 2019

OK, first of all, I'm unable to trigger that message.

Secondly, the proposed change is incorrect here. In the doc repo, curly brace is used to refer to {. However, this error message talks about any opening bracket that is supported by #` (through unicode). It can be changed to something more generic (like opener or something better).

@AlexDaniel
Copy link
Contributor

That error message looks like bitrot to me. Last related changes to the code are 7 years ago or so:

I can't even use bisectable for that because it can only go back to 2014.01.

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

No branches or pull requests

3 participants