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.

Sign up for GitHub

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

Jump to bottom

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
Fix documentation examples
d54df24 
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
@lexnv
CI: Add cargo test --doc
d3baa32 
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
jsdw reviewed Jun 15, 2022
View reviewed changes
docs/subxt.md Outdated Show resolved Hide resolved
jsdw
jsdw reviewed Jun 15, 2022
View reviewed changes
docs/subxt.md Outdated Show resolved Hide resolved
@jsdw
Copy link
Collaborator

jsdw commented Jun 16, 2022 •
edited
Loading

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
@lexnv @niklasad1
Update .github/workflows/rust.yml
b282f84 
Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>
@lexnv
Remove docs/subxt.md and move documentation to subxt/lib.rs
2587ac1 
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 😄

jsdw
jsdw reviewed Jun 16, 2022
View reviewed changes
subxt/src/events/mod.rs Outdated Show resolved Hide resolved
jsdw
jsdw reviewed Jun 16, 2022
View reviewed changes
subxt/src/lib.rs Outdated Show resolved Hide resolved
jsdw
jsdw approved these changes Jun 16, 2022
View reviewed changes
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
Hide polkadot interface for events/mod.rs
7d94a87 
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
@lexnv
docs: Use # for headers
ac45e16 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jsdw jsdw jsdw approved these changes

@niklasad1 niklasad1 niklasad1 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lexnv @jsdw @niklasad1