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

Docs: Add an "Attributes" section #2359

Merged
merged 5 commits into from
Apr 10, 2023
Merged

Conversation

adpaco-aws
Copy link
Contributor

@adpaco-aws adpaco-aws commented Apr 7, 2023

Description of changes:

Adds an "Attributes" section to our documentation.

Access the preview here.

Resolved issues:

Resolves #2208
Resolves #2316

Testing:

  • How is this change tested? N/A

  • Is this a refactor change? N/A

Checklist

  • Each commit message has a non-empty body, explaining why the change was made
  • Methods or procedures are documented
  • Regression or unit tests are included, or existing tests cover the modified code
  • My PR is restricted to a single feature or bugfix

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

@adpaco-aws adpaco-aws requested a review from a team as a code owner April 7, 2023 20:23
Copy link
Contributor

@karkhaz karkhaz left a comment

Choose a reason for hiding this comment

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

Thank you, it's great to have all these organized here.

docs/src/reference/attributes.md Show resolved Hide resolved
Copy link
Contributor

@zhassan-aws zhassan-aws left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of this @adpaco-aws!

docs/src/reference/attributes.md Outdated Show resolved Hide resolved
docs/src/reference/attributes.md Outdated Show resolved Hide resolved
docs/src/reference/attributes.md Outdated Show resolved Hide resolved
docs/src/reference/attributes.md Outdated Show resolved Hide resolved
docs/src/reference/attributes.md Show resolved Hide resolved
docs/src/reference/attributes.md Outdated Show resolved Hide resolved
docs/src/reference/attributes.md Outdated Show resolved Hide resolved
docs/src/reference/attributes.md Outdated Show resolved Hide resolved
docs/src/reference/attributes.md Outdated Show resolved Hide resolved
docs/src/reference/attributes.md Outdated Show resolved Hide resolved
adpaco-aws and others added 3 commits April 10, 2023 10:52
Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
@adpaco-aws adpaco-aws enabled auto-merge (squash) April 10, 2023 16:34
@adpaco-aws adpaco-aws merged commit 1449e62 into model-checking:main Apr 10, 2023
karkhaz added a commit to karkhaz/kani that referenced this pull request Apr 19, 2023
* The Kani reference now includes an
  ["Attributes"](https://model-checking.github.io/kani/reference/attributes.html)
  section that describes each of the attributes available in Kani
  ([pull request](model-checking#2359)
by @adpaco-aws)
* Users' choice of SAT solver, specified by the `solver` attribute,
  is now propagated to the loop-contract synthesizer ([pull
  request](model-checking#2320) by
  @qinheping)
* Unit tests generated by the concrete playback feature now compile
  correctly when using `RUSTFLAGS="--cfg=kani"` ([pull
  request](model-checking#2353) by
@jaisnan)
* The Rust toolchain is updated to 2023-02-18 ([pull
  request](model-checking#2384) by
  @tautschnig)
@karkhaz karkhaz mentioned this pull request Apr 19, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for the #[kani::should_panic] attribute Add a section on Kani attributes to the docs
3 participants