test: Fix up doc tests and run them on CI #1057
Open
+116
−60
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
igamigo
requested review from
Mirko-von-Leipzig and
PhilippGackstatter
and removed request for
Mirko-von-Leipzig
igamigo
added
the
no changelog
PhilippGackstatter
approved these changes
Jan 10, 2025
| /// .unwrap(); | ||
| /// mock_chain.seal_block(None); | ||
| /// let tx_context = mock_chain.build_tx_context(sender.id(), &[note.id()], &[]).build(); | ||
| /// // tx_context.execute(); |
There was a problem hiding this comment.
If we can't make it a full example and have to comment this line, should we just add no_run (https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#attributes)? That way it's compiled but not executed which seems fine here.
There was a problem hiding this comment.
Ah yes, that sounds good.
Comment on lines
179
to
185
| /// let template = AccountComponentTemplate::new(component_template, library); | ||
| /// | ||
| /// let component = AccountComponent::from_template(&template, &init_storage_data)?; | ||
| /// # Ok(()) | ||
| /// # } | ||
| /// ``` | ||
|
|
There was a problem hiding this comment.
What do you think about moving this example to the type-level, e.g. on AccountComponentMetadata directly for more visibility?
Mirko-von-Leipzig
approved these changes
Jan 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.