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

DOC-430 | Documentation for Sanity Check for Solana #337

Merged
merged 4 commits into from
Jan 21, 2025

Conversation

johspaeth
Copy link
Contributor

Naming convention:

  • PRs for features that are in design should have the "proposal" label
  • PRs for features that haven't landed yet should have the "future" label
  • PRs for upcoming releases should have the "release" label
  • PRs with new documentation for existing features should have the "existing feature" label

Before requesting review:

  • Make sure there is a ticket in the DOC board in Jira
  • Make sure CI is passing
    • Spell check failure may require adding backticks around code or updating spelling_wordlist.txt
    • See README.md for information about style and markdown syntax
    • If the CI Details link gives a 404, you need to log in to readthedocs.com
  • Add link to generated documentation here
    • you can find this by following the read the docs link from the CI check
  • Ask for help in #documentation

Jira ticket: TODO
Link to generated documentation: TODO

@johspaeth johspaeth changed the base branch from master to solana/docs_template January 20, 2025 12:19
Copy link

@phreppo phreppo left a comment

Choose a reason for hiding this comment

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

LGTM, only minor comments.
Feel free to incorporate or reject them.

docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Outdated Show resolved Hide resolved
docs/solana/sanity.md Show resolved Hide resolved
Comment on lines 44 to 46
cvt_assume!(amount >= 2);
cvt_assume!(amount <= 1);
cvt_assert!(amount == 1); //Expect a sanity failure here as the assumes are conflicting.
Copy link

Choose a reason for hiding this comment

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

Also, I think that we are using the prefix cvlr_ for our functions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. This is something to keep an eye on in particular.

@phreppo
Copy link

phreppo commented Jan 21, 2025

I think that there are still some comments in the "hidden" section that maybe should be merged (e.g. the double that).

@johspaeth
Copy link
Contributor Author

I think that there are still some comments in the "hidden" section that maybe should be merged (e.g. the double that).

👍 I'll doube check

@johspaeth johspaeth merged commit 36a8fd8 into solana/docs_template Jan 21, 2025
2 checks passed
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.

2 participants