You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@groovy.apache.org by "fanofxiaofeng (via GitHub)" <gi...@apache.org> on 2024/11/09 03:23:42 UTC

[PR] Update style-guide.adoc with 4 proper rendering of "`" character [groovy]

fanofxiaofeng opened a new pull request, #2119:
URL: https://github.com/apache/groovy/pull/2119

   As mentioned in Example 6 in https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#text-formatting, 
   two consecutive "`" character can be used to render unconstrained italic (I think it means italic that are not constrained to boundary of words)
   <img width="837" alt="assert" src="https://github.com/user-attachments/assets/95e8b340-334e-42ba-b27f-664a77bce68b">
   There are four places that "`" is not rendered as expected in this adoc file, I tried to fix all of them.
   Please help review. Thanks
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@groovy.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update style-guide.adoc with 4 proper rendering of "`" character [groovy]

Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #2119:
URL: https://github.com/apache/groovy/pull/2119#issuecomment-2466029908

   ## [Codecov](https://app.codecov.io/gh/apache/groovy/pull/2119?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
   All modified and coverable lines are covered by tests :white_check_mark:
   > Project coverage is 68.6608%. Comparing base [(`6cd477b`)](https://app.codecov.io/gh/apache/groovy/commit/6cd477b3157675f0ceee9fbd62e3efd0cc9bdb3e?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) to head [(`31bcef4`)](https://app.codecov.io/gh/apache/groovy/commit/31bcef4ac3c3bebb48c4a9e0c1216995b514d41c?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
   > Report is 329 commits behind head on master.
   
   <details><summary>Additional details and impacted files</summary>
   
   
   [![Impacted file tree graph](https://app.codecov.io/gh/apache/groovy/pull/2119/graphs/tree.svg?width=650&height=150&src=pr&token=1r45138NfQ&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)](https://app.codecov.io/gh/apache/groovy/pull/2119?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
   
   ```diff
   @@                Coverage Diff                 @@
   ##               master      #2119        +/-   ##
   ==================================================
   + Coverage     68.5957%   68.6608%   +0.0651%     
   - Complexity      29233      29416       +183     
   ==================================================
     Files            1426       1427         +1     
     Lines          113494     113631       +137     
     Branches        19548      19634        +86     
   ==================================================
   + Hits            77852      78020       +168     
   + Misses          29088      29047        -41     
   - Partials         6554       6564        +10     
   ```
   
   [see 94 files with indirect coverage changes](https://app.codecov.io/gh/apache/groovy/pull/2119/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
   
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@groovy.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update style-guide.adoc with 4 proper rendering of "`" character [groovy]

Posted by "fanofxiaofeng (via GitHub)" <gi...@apache.org>.
fanofxiaofeng commented on PR #2119:
URL: https://github.com/apache/groovy/pull/2119#issuecomment-2466028323

   OK, thanks for the details.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@groovy.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update style-guide.adoc with 4 proper rendering of "`" character [groovy]

Posted by "paulk-asert (via GitHub)" <gi...@apache.org>.
paulk-asert commented on PR #2119:
URL: https://github.com/apache/groovy/pull/2119#issuecomment-2466026939

   Thanks for spotting those. I suspect they might have worked as is on a very old version of Asciidoc. In any case, I think the sentence could be made clearer without the pluralization of those keywords. I might try to reword if I can find time.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@groovy.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update style-guide.adoc with 4 proper rendering of "`" character [groovy]

Posted by "paulk-asert (via GitHub)" <gi...@apache.org>.
paulk-asert commented on code in PR #2119:
URL: https://github.com/apache/groovy/pull/2119#discussion_r1835235874


##########
src/spec/doc/style-guide.adoc:
##########
@@ -622,7 +622,7 @@ and the resulting value will be null if something's `null`.
 
 To check your parameters, your return values, and more, you can use the `assert` statement.
 
-Contrary to Java's `assert`, `assert`s don't need to be activated to be working, so `assert`s are always checked.

Review Comment:
   Actually, we probably want all those examples to be code escaping.



##########
src/spec/doc/style-guide.adoc:
##########
@@ -622,7 +622,7 @@ and the resulting value will be null if something's `null`.
 
 To check your parameters, your return values, and more, you can use the `assert` statement.
 
-Contrary to Java's `assert`, `assert`s don't need to be activated to be working, so `assert`s are always checked.

Review Comment:
   looks like two more at the start of this line?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@groovy.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update style-guide.adoc with 4 proper rendering of "`" character [groovy]

Posted by "paulk-asert (via GitHub)" <gi...@apache.org>.
paulk-asert commented on code in PR #2119:
URL: https://github.com/apache/groovy/pull/2119#discussion_r1835235507


##########
src/spec/doc/style-guide.adoc:
##########
@@ -622,7 +622,7 @@ and the resulting value will be null if something's `null`.
 
 To check your parameters, your return values, and more, you can use the `assert` statement.
 
-Contrary to Java's `assert`, `assert`s don't need to be activated to be working, so `assert`s are always checked.

Review Comment:
   looks like two more at the start of this line?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@groovy.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update style-guide.adoc with 4 proper rendering of "`" character [groovy]

Posted by "paulk-asert (via GitHub)" <gi...@apache.org>.
paulk-asert commented on code in PR #2119:
URL: https://github.com/apache/groovy/pull/2119#discussion_r1835235874


##########
src/spec/doc/style-guide.adoc:
##########
@@ -622,7 +622,7 @@ and the resulting value will be null if something's `null`.
 
 To check your parameters, your return values, and more, you can use the `assert` statement.
 
-Contrary to Java's `assert`, `assert`s don't need to be activated to be working, so `assert`s are always checked.

Review Comment:
   Actually, we probably want all those examples to be code escaping.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@groovy.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Update style-guide.adoc with 4 proper rendering of "`" character [groovy]

Posted by "paulk-asert (via GitHub)" <gi...@apache.org>.
paulk-asert merged PR #2119:
URL: https://github.com/apache/groovy/pull/2119


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@groovy.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org