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.

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

Add blocks for the notes #769

Merged
merged 1 commit into from
Jul 28, 2023

Conversation

Halbaroth
Copy link
Collaborator

This PR uses the block of Sphinx to emphasize notes in the documentation.
It also includes minor fixes.

@Halbaroth Halbaroth added this to the 2.5.0 milestone Jul 28, 2023
@Halbaroth Halbaroth changed the title Add block for the notes Add blocks for the notes Jul 28, 2023
Copy link
Collaborator

@bclement-ocp bclement-ocp left a comment

Choose a reason for hiding this comment

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

Not 100% sure all of these deserve the extra emphasis but we can also revisit later if needed

Comment on lines +89 to +95
```{admonition} Note

In this example the model for the statement `check_sat c2` is not a
model for the statement `check_sat c1` since `check_sat` are independent in
the native language. The same goes for `goals`.

Using the SMT-LIB language in the input file `INPUT.smt2`:
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think this one should be an admonition, it is more a remark that doesn't deserve specific emphasis imo; it would be fine to keep it in the main content.

Comment on lines +125 to +129
```{admonition} Note

There is no model printed after the second `(check-sat)` since we
don't demand it with the statement `(get-model)`.
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ditto, I think having this one as an admonition is more distracting than anything

@Halbaroth Halbaroth merged commit 2b57da1 into OCamlPro:next Jul 28, 2023
Halbaroth added a commit to Halbaroth/alt-ergo that referenced this pull request Jul 28, 2023
@Halbaroth Halbaroth mentioned this pull request Jul 28, 2023
@Halbaroth Halbaroth mentioned this pull request Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants