Skip to content

Add support for modifying examples in the Rust books.#447

Merged
adpaco-aws merged 2 commits intomodel-checking:main-154-2021-08-24from
bdalrhm:diff
Aug 31, 2021
Merged

Add support for modifying examples in the Rust books.#447
adpaco-aws merged 2 commits intomodel-checking:main-154-2021-08-24from
bdalrhm:diff

Conversation

@bdalrhm
Copy link
Copy Markdown
Contributor

@bdalrhm bdalrhm commented Aug 23, 2021

Description of changes:

This PR adds support for modifying examples in the Rust books by adding a diff file with the same name as the example in src/tools/dashboard/configs.

Resolved issues:

Resolves #408

Call-outs:

To avoid duplicating code, the dashboard now depends on some of rustdoc's internal API, some of which were made public as necessary.

Testing:

  • How is this change tested?
    • Terminal and Litani dashboard still work as expected.
  • Is this a refactor change?
    • No.

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.

Signed-off-by: Abdalrhman M Mohamed <bdalrhm@amazon.com>
Signed-off-by: Abdalrhman M Mohamed <bdalrhm@amazon.com>
@adpaco-aws adpaco-aws changed the base branch from main-154-2021-08-17 to main-154-2021-08-24 August 31, 2021 13:56

#[derive(Clone, Default)]
crate struct TestOptions {
pub struct TestOptions {
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.

I think my only concern is the potential for future conflicts from stuff like this, but if it's fine with your Adrian, then it's fine with me.

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.

Good point, opened #461 to keep track of this. @bdalrhm had linking issues when not doing this and we agreed to change it in order to have the PR online.

@adpaco-aws adpaco-aws merged commit 898906c into model-checking:main-154-2021-08-24 Aug 31, 2021
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 26, 2022
…#447)

* Add support for modifying examples in the Rust books.

Signed-off-by: Abdalrhman M Mohamed <bdalrhm@amazon.com>

* Punctuation.

Signed-off-by: Abdalrhman M Mohamed <bdalrhm@amazon.com>
tedinski pushed a commit that referenced this pull request Apr 27, 2022
* Add support for modifying examples in the Rust books.

Signed-off-by: Abdalrhman M Mohamed <bdalrhm@amazon.com>

* Punctuation.

Signed-off-by: Abdalrhman M Mohamed <bdalrhm@amazon.com>
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.

Look for custom assertions to add to the examples.

3 participants