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

Improve the docs #48

Merged
merged 4 commits into from
Jan 26, 2025
Merged

Improve the docs #48

merged 4 commits into from
Jan 26, 2025

Conversation

tcharding
Copy link
Member

Improve docs:

  • repo docs
  • MSRV docs
  • types docs

@tcharding tcharding mentioned this pull request Jan 23, 2025
Merged
@apoelstra
Copy link
Member

In 967a63e: this commit adds two unrelated newlines.

In 7614110: trailing whitespace

@tcharding
Copy link
Member Author

tcharding commented Jan 23, 2025 •
edited
Loading

Its like its my first day here.

@tcharding
doc: Add mention of jsonrpc
62a5028 
We moved the `jsonrpc` crate here a while ago but forgot to mention it
in the crate list in the repo README - do so.
@tcharding
Try to explain the odd design
58bad5f 
The problems this crate solves and does not solve is not immediately
obvious. Make an effort to explain them.
@tcharding
doc: Update MSRV
ecce5b0 
We have a bunch of stale MSRV docs. Update them all and make the form
uniform.
@apoelstra
Copy link
Member

In a49a103: typo carog should be cargo.

Otherwise LGTM!

@tcharding
types: Improve README
832fe91 
The `types` crate is currently under documented. Improve the
documentation in the crate's readme.
@tcharding
Copy link
Member Author

Fixed, thanks.

apoelstra
apoelstra approved these changes Jan 26, 2025
View reviewed changes
Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK 832fe91; successfully ran local tests

@apoelstra apoelstra merged commit b62e8c8 into rust-bitcoin:master Jan 26, 2025
27 checks passed
@tcharding tcharding deleted the 01-23-docs branch February 4, 2025 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apoelstra apoelstra apoelstra 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.
2 participants
@tcharding @apoelstra