-
-
Notifications
You must be signed in to change notification settings - Fork 619
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
Update checkaction.md #2045
base: master
Are you sure you want to change the base?
Update checkaction.md #2045
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for taking your time! Please use git commit --amend
when resolving my comments
@@ -1,4 +1,5 @@ | |||
checkaction - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. | |||
checkaction - What should happend when an assertion fails (D Lang) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- The
checkaction -
is redundant. We use filename as a title then you can start right away with a description. - It's important to be more explicit. Instead of
(D Lang)
add: This option applies only to D Programming Language
* `Halt`: cause program halt on failure | ||
* `Context`: call D assert with the error context on failure | ||
|
||
See https://dlang.org/library/dmd/globals/checkaction.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use proper Markdown signature for hyperlinks: [text](url)
* `Halt`: cause program halt on failure | ||
* `Context`: call D assert with the error context on failure | ||
|
||
See https://dlang.org/library/dmd/globals/checkaction.html | ||
|
||
## Applies To ### | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to align the example, because it is not valid now. Use: checkaction "Halt"
Just poking this to see if changes will be made. |
Quick and Lazy documentation patch