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.

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

Jump to bottom

Update checkaction.md #2045

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update checkaction.md #2045

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
13 changes: 8 additions & 5 deletions website/docs/checkaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Copy link
Member

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



```lua
checkaction (value)
Expand All @@ -9,10 +10,12 @@ checkaction (value)
`value` is one of:

* `Default`: needs documentation
* `D`: needs documentation
* `C`: needs documentation
* `Halt`: needs documentation
* `Context`: needs documentation
* `D`: call D assert on failure
* `C`: call C assert on failure
* `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
Copy link
Member

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)


## Applies To ###

Copy link
Member

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"

Expand Down