Skip to content

Add reference for loop contracts - #3849

Merged
qinheping merged 9 commits into
model-checking:mainfrom
qinheping:docs/loop-contracts
Feb 4, 2025
Merged

Add reference for loop contracts#3849
qinheping merged 9 commits into
model-checking:mainfrom
qinheping:docs/loop-contracts

Conversation

@qinheping

@qinhepingqinheping commented Jan 23, 2025

Copy link
Copy Markdown
Contributor

This PR adds reference of loop contracts:
Rendered version: https://github.com/qinheping/kani/blob/docs/loop-contracts/docs/src/reference/experimental/loop-contracts.md

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

@qinheping
qinheping requested a review from a team as a code ownerJanuary 23, 2025 22:15
zhassan-aws
zhassan-aws reviewed Jan 24, 2025
View reviewed changes

@zhassan-awszhassan-aws left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice!

Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
@feliperodrifeliperodri added [C] Documentation Additions and improvements to our documentation Z-Contracts Issue related to code contracts labels Jan 26, 2025
@qinheping

qinheping commented Jan 28, 2025

Copy link
Copy Markdown
ContributorAuthor

@zhassan-aws , thank you for the feedbacks! I addressed the comments above.

zhassan-aws
zhassan-aws approved these changes Jan 28, 2025
View reviewed changes
Comment threaddocs/src/reference/experimental/loop-contracts.md
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
Comment threaddocs/src/reference/experimental/loop-contracts.md Outdated
qinhepingand others added 2 commits January 29, 2025 10:19
@qinheping@zhassan-aws
Apply suggestions from code review
bf05956
Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
@qinheping
Merge branch 'main' into docs/loop-contracts
6448cea
@carolynzech

carolynzech commented Feb 4, 2025

Copy link
Copy Markdown
Contributor

@qinheping Is this blocked on anything? If not, can you resolve that last comment and merge?

@qinheping
qinheping added this pull request to the merge queueFeb 4, 2025
Merged via the queue into model-checking:main with commit 380b1fbFeb 4, 2025
@qinheping
qinheping deleted the docs/loop-contracts branch February 4, 2025 20:29
@carolynzechcarolynzech mentioned this pull request Feb 5, 2025
Merged
github-merge-queueBot pushed a commit that referenced this pull request Feb 6, 2025
Carolyn Zech@zhassan-aws
Bump Kani version to 0.59.0 (#3876)
2955d5e
Github generated release notes:
## What's Changed
* Automatic toolchain upgrade to nightly-2025-01-08 by @github-actions
in #3821
* Automatic cargo update to 2025-01-13 by @github-actions in
#3824
* Automatic toolchain upgrade to nightly-2025-01-09 by @github-actions
in #3825
* Bump ncipollo/release-action from 1.14.0 to 1.15.0 by @dependabot in
#3826
* Bump tests/perf/s2n-quic from `ac52a48` to `adc7ba9` by @dependabot in
#3827
* Automatic toolchain upgrade to nightly-2025-01-10 by @github-actions
in #3828
* Automatic toolchain upgrade to nightly-2025-01-11 by @github-actions
in #3830
* Verify contracts/stubs for generic types with multiple inherent
implementations by @carolynzech in
#3829
* Update Charon submodule by @thanhnguyen-aws in
#3823
* Automatic toolchain upgrade to nightly-2025-01-12 by @github-actions
in #3831
* Automatic toolchain upgrade to nightly-2025-01-13 by @github-actions
in #3833
* Upgrade toolchain to 2025-01-15 by @tautschnig in
#3835
* Automatic toolchain upgrade to nightly-2025-01-16 by @github-actions
in #3836
* Add a regression test for `no_std` feature by @carolynzech in
#3837
* Use fully-qualified name for size_of by @zhassan-aws in
#3838
* Automatic cargo update to 2025-01-20 by @github-actions in
#3842
* Bump tests/perf/s2n-quic from `adc7ba9` to `f0649f9` by @dependabot in
#3844
* Upgrade toolchain to nightly-2025-01-22 by @tautschnig in
#3843
* Remove `DefKind::Ctor` from filtering crate items by @carolynzech in
#3845
* Enable valid_ptr post_condition harnesses by @tautschnig in
#3847
* Update build command in docs to use release mode by @zhassan-aws in
#3846
* Automatic toolchain upgrade to nightly-2025-01-23 by @github-actions
in #3848
* Automatic toolchain upgrade to nightly-2025-01-24 by @github-actions
in #3850
* Remove the openssl-devel package from dependencies by @zhassan-aws in
#3852
* Fix validity checks for `char` by @celinval in
#3853
* Bump tests/perf/s2n-quic from `f0649f9` to `4500593` by @dependabot in
#3857
* Automatic cargo update to 2025-01-27 by @github-actions in
#3856
* Deprecate `--enable-unstable` and `--restrict-vtable` by @celinval in
#3859
* Stub linker to avoid missing symbols errors by @celinval in
#3858
* Toolchain upgrade to nightly-2025-01-28 by @feliperodri in
#3855
* Allow multiple annotations, but check for duplicate targets. by
@remi-delmas-3000 in #3808
* Move documentation of kani_core modules to right places by @qinheping
in #3851
* Fix missing function declaration issue by @celinval in
#3862
* Fix transmute codegen when sizes are different by @celinval in
#3861
* Remove symtab2gb from bundle by @zhassan-aws in
#3865
* Update the rustc hack for CLion / RustRover by @celinval in
#3868
* Bump tests/perf/s2n-quic from `4500593` to `82dd0b5` by @dependabot in
#3872
* Automatic cargo update to 2025-02-03 by @github-actions in
#3869
* Add reference for loop contracts by @qinheping in
#3849
* remove flag float-overflow-check by @rajath-mk in
#3873
## New Contributors
* @rajath-mk made their first contribution in
#3873
**Full Changelog**:
kani-0.58.0...kani-0.59.0
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 and MIT licenses.
---------
Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@zhassan-awszhassan-awszhassan-aws approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@qinhepingqinheping

Labels

[C] DocumentationAdditions and improvements to our documentationZ-ContractsIssue related to code contracts

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@qinheping@carolynzech@zhassan-aws@feliperodri