Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix documentation examples #568

Merged
merged 6 commits into from
Jun 16, 2022
Merged

Fix documentation examples #568

merged 6 commits into from
Jun 16, 2022

Conversation

lexnv
Copy link
Collaborator

@lexnv lexnv commented Jun 15, 2022

This PR ensures that the cargo test --doc is passing.

While at it, added a rule for the CI to run this command.

lexnv added 2 commits June 15, 2022 19:21
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
@lexnv lexnv requested a review from a team as a code owner June 15, 2022 16:30
@jsdw
Copy link
Collaborator

jsdw commented Jun 16, 2022

I love the fixed doc examples! My vote on this PR would be to remove the rusty example bits from the markdown file and merge the rest!

lexnv and others added 2 commits June 16, 2022 11:57
Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
@lexnv
Copy link
Collaborator Author

lexnv commented Jun 16, 2022

Have removed the docs folder in favor of the docs.rs documentation. Thedocs/subxt.md is now part of the src/lib.rs main documentation, that's a bit better in terms of readability of the examples 😄

Copy link
Collaborator

@jsdw jsdw left a comment

Choose a reason for hiding this comment

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

A couple of wee nits but looks great, nice one!

@jsdw jsdw requested a review from niklasad1 June 16, 2022 10:46
lexnv added 2 commits June 16, 2022 14:06
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
@jsdw jsdw merged commit 8bceda2 into master Jun 16, 2022
@jsdw jsdw deleted the fix_doc_tests branch June 16, 2022 13:25
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants