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

Define how "Assert:" works #98

Merged
merged 2 commits into from
Mar 24, 2017
Merged

Define how "Assert:" works #98

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c25e15a
Define how "Assert:" works
annevk Mar 23, 2017
3b61f95
address feedback
annevk Mar 24, 2017
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
12 changes: 12 additions & 0 deletions infra.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,18 @@ iteration.
</div>


<h3 id=assertions>Assertions</h3>

<p>To improve readability, it can sometimes help to add assertions to algorithms, stating
invariants. To do this, write "<code>Assert: </code>", followed by a statement that must be true.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be <code>; just normal font is fine.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Elsewhere we say that strings should use code.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But I guess we haven't done it for algorithm keywords per se.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this isn't a string in the sense of the data type.


<div class=example id=example-assert>
<ol>
<li><p>Let |x| be "<code>Aperture Science</code>".
<li><p>Assert: |x| is "<code>Aperture Science</code>".
</div>


<h2 id=primitive-data-types>Primitive data types</h2>

<h3 id=bytes>Bytes</h3>
Expand Down