[AssertExpression] Improve docs #3572
Conversation
Add contract and other links. Move compile-time evaluated condition paragraph down to its own subheading (avoid distracting from the runtime evaluation docs which are quite complicated). Add short example. Change link to precondition (contracts spec is a stub). Move second argument sentence down to its own subheading. Reword paragraph about compiler switches. Remove 'continuing execution' list item - that seems to be covered by the first sentence (whether the condition is evaluated or not). For CT evaluation, avoid mentioning 'release mode' which was undefined.
ntrel
requested review from
andralex,
WalterBright,
maxhaton and
mdparker
as code owners
|
Thanks for your pull request and interest in making D better, @ntrel! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please see CONTRIBUTING.md for more information. If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment. Bugzilla referencesYour PR doesn't reference any Bugzilla issue. If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog. |
| $(H4 $(LNAME2 assert-message, Assert Message)) | ||
|
|
||
| $(P The second $(I AssignExpression), if present, must be implicitly | ||
| convertible to type $(D const(char)[]). |
There was a problem hiding this comment.
assert can now have multiple parameters, each of which is converted to string and concatenated. So this sentence should start with "any following AssignExpression, if present, ...
There was a problem hiding this comment.
@Lyratelle No that only works with static assert. Otherwise dmd would have to link in a runtime function to e.g. convert int to string.
Edit: I suppose dmd could allow multiple arguments for assert if they are all strings, though then you might as well just write concatenations.
Change link to use precondition spec in function.dd (contracts spec is a stub).
Fix broken anchor in contracts.dd.
Add class invariant link.
Move compile-time evaluated condition paragraph down to its own subheading (avoid distracting from the runtime evaluation docs which are quite complicated).
Add short example.
Move message argument sentence down to its own subheading.
Reword paragraph about compiler switches. Remove 'continuing execution' list item - that seems to be covered by the first sentence (whether the condition is evaluated or not).
Move best practice section up.
For CT evaluation, avoid mentioning 'release mode' which was undefined.
Add link to static assert.