Skip to content

Conversation

@JustusAdam
Copy link
Contributor

@JustusAdam JustusAdam commented Sep 10, 2023

Description of changes:

The function contracts RFC as rendered on the website has broken footnotes. The reason is that mdbooks renders markdown differently than GitHub (of course, why would the same syntax, for the same language exhibit the same behavior with two different compilers, that'd just be silly.). Instead of rendering all footnotes at the bottom they were interspersed with the text, breaking the reading flow. In addition the footnotes of mdbook do not support multiple paragraphs and code blocks so one of the footnotes required rephrasing.

Also fixes the incorrectly named -Zcontracts feature flag

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.

@JustusAdam JustusAdam changed the title Fixing the footnotes on function contracts rfc Fixing the Footnotes on the Function Contracts RFC Sep 10, 2023
@JustusAdam JustusAdam changed the title Fixing the Footnotes on the Function Contracts RFC Fixing the Footnotes and Feature Flag on the Function Contracts RFC Sep 10, 2023
@JustusAdam JustusAdam marked this pull request as ready for review September 11, 2023 22:21
@JustusAdam JustusAdam requested a review from a team as a code owner September 11, 2023 22:21
@jaisnan
Copy link
Contributor

jaisnan commented Sep 11, 2023

Can you link or add the screenshot for the rendered page after the change?

Copy link
Contributor

@jaisnan jaisnan left a comment

Choose a reason for hiding this comment

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

Approving! If possible, could you add a link to rendered page after the change?

@JustusAdam
Copy link
Contributor Author

Approving! If possible, could you add a link to rendered page after the change?

Is this what you were thinking of?

Screenshot 2023-09-11 at 5 02 18 PM

@jaisnan
Copy link
Contributor

jaisnan commented Sep 12, 2023

Approving! If possible, could you add a link to rendered page after the change?

Is this what you were thinking of?

Screenshot 2023-09-11 at 5 02 18 PM

Yes, thank you! Looks great!

@JustusAdam JustusAdam merged commit 6d628bf into model-checking:main Sep 12, 2023
@JustusAdam JustusAdam deleted the fix-footnotes branch September 12, 2023 17:51
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.

3 participants