Static guarantees look forward to Design Contracts

Open
#159 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Open the linked Static Guarantees page and read the sections leading up to Design Contracts. Add a brief note that the intermediate solutions are building toward the zero-overhead solution with strong guarantees presented there, then verify the wording and documentation link render correctly.

Written by the indexing model from the issue text.

Description

https://rust-embedded.github.io/book/static-guarantees/index.html

As far as i understand the best solution is presented in the section Design Contracts

A sentence could be added here saying "we will present a zero-overhead solution with strong guarantees in the Design Contracts section" or something similar. Because the chapter(s) before Design Contracts also follow the present-a-solution-but-do-not-use-this pattern. Heads up that we will discard intermediate solution and build up to the ultimate solution would be appreciated.

Dominant language
No language data
Stars
1.3k
Forks
223
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.