[GitHub] [wicket] haster opened a new pull request #446: Replace literal asterisk by asterisk attribute

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

[GitHub] [wicket] haster opened a new pull request #446: Replace literal asterisk by asterisk attribute

GitBox

haster opened a new pull request #446:
URL: https://github.com/apache/wicket/pull/446


   The "backslash-escape" method of rendering a literal asterisk resulted confusing documentation since the backslash sometimes got rendered, and sometimes didn't. Using literal asterisk of course ran into the risk of rendering bolded text and no asterisks.
   
   By replacing the literal asterisks with the attributes '{asterisk}' and letting asciidoctor render an asterisk the generated documentation should be clearer.
   
   Example of the documentation currently live in the user guide (with confusing rendering of backslashes):
   
   ----------
   wildcard character “*” is supported as placeholder for zero or more characters. For example pattern “+\*.mp4” adds all the mp4 files inside all directories.
   
   subdirectories are supported as well. For example pattern “+documents/*.pdf” adds all pdf files under “documents” directory. Character “\*” can be used with directories to specify a nesting level. For example “+documents/*/\*.pdf” adds all pdf files placed one level below “documents” directory.
   
   a double wildcard character “*\*” indicates zero or more subdirectories. For example pattern “+documents/*\*/\*.pdf” adds all pdf files placed inside “documents” directory or inside any of its subdirectories.
   ----------


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
[hidden email]


Reply | Threaded
Open this post in threaded view
|

[GitHub] [wicket] asfgit closed pull request #446: Replace literal asterisk by asterisk attribute

GitBox

asfgit closed pull request #446:
URL: https://github.com/apache/wicket/pull/446


   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
[hidden email]