Skip to content

Changed {} to § in Markdown for function arguments #190

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.

Sign up for GitHub

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

Closed
sebasguts wants to merge 1 commit into from
Closed

Changed {} to § in Markdown for function arguments #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/Comments.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,11 +742,11 @@ can be important.</E>
<Subsection Label="MarkdownExtensionArgument">
<Heading>Function arguments</Heading>

One can mark function parameters by using curly braces ({}) at the
One can mark function parameters by using paragraphs (§) at the
beginning and the end of the text which should be marked as a parameter. Example:

<Listing><![CDATA[
#! The function takes one parameter {a}
#! The function takes one parameter §a§
]]></Listing>

This produces the following output:<Br/>
Expand Down
2 changes: 1 addition & 1 deletion gap/Markdown.gi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ InstallGlobalFunction( CONVERT_LIST_OF_STRINGS_IN_MARKDOWN_TO_GAPDOC_XML,
[ [ "`", "`" ], "Code" ],
[ [ "**", "**" ], "Emph" ],
[ [ "__", "__" ], "Emph" ],
[ [ "{", "}" ], "A"] ];
[ [ "§", "§" ], "A"] ];
## special handling for \$
for i in [ 1 .. Length( string_list ) ] do
string_list[ i ] := ReplacedString( string_list[ i ], "\\$", "&#36;" );
Expand Down
2 changes: 1 addition & 1 deletion tst/worksheets/general.sheet/worksheet.g
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Print( "(Even though we never use it that way.\n" );
#! * This is __emphasized__ text in a list item.
#! * This is also **emphasized** text in a list item.
#! * This is `inline code` in a list item.
#! * {A} is an argument.
#! * §A§ is an argument.
#!
#! All of this can **also** be __used__ outside of a `list`.

Expand Down