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

Add documentation for the db-analyser tool #3435

Merged
merged 1 commit into from
Oct 24, 2021
Merged

Add documentation for the db-analyser tool #3435

merged 1 commit into from
Oct 24, 2021

Conversation

EncodePanda
Copy link
Contributor

No description provided.

jasagredo
jasagredo approved these changes Oct 18, 2021
View reviewed changes
Copy link
Contributor

@jasagredo jasagredo left a comment

Choose a reason for hiding this comment

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

Merely wording comments. Otherwise it looks fine to me.

ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
nfrisby
nfrisby requested changes Oct 18, 2021
View reviewed changes
Copy link
Contributor

@nfrisby nfrisby left a comment

Choose a reason for hiding this comment

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

Nice docs! I see that Jared already tagged it with a ❤️ :D

My comments are mostly Markdown formatting and missing/mixed up definite and indefinite articles. (It's perfectly comprehensible as-is, for what it's worth.)

ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated Show resolved Hide resolved
ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Show resolved Hide resolved
@EncodePanda
Copy link
Contributor Author

I love how Haskell CI breaks on this one even though Haskell code was not touched :)

@EncodePanda EncodePanda force-pushed the EncodePanda/CAD-3383/documentation branch from 16de794 to d9d60e3 Compare October 21, 2021 11:53
@EncodePanda
Copy link
Contributor Author

Fixed. Squashed. Pushed. Ready for review. @nfrisby

@EncodePanda EncodePanda force-pushed the EncodePanda/CAD-3383/documentation branch 3 times, most recently from 0e465f0 to d334fc6 Compare October 21, 2021 11:59
nfrisby
nfrisby approved these changes Oct 21, 2021
View reviewed changes
Copy link
Contributor

@nfrisby nfrisby left a comment

Choose a reason for hiding this comment

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

One very minor comment; optional.

Thanks! Approving.

ouroboros-consensus-cardano/tools/db-analyser/Documentation.md Outdated

* `--show-slot-block-no` Will print the slot and block number of each block it process


Copy link
Contributor

Choose a reason for hiding this comment

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

Minor: extra newline here

@EncodePanda EncodePanda force-pushed the EncodePanda/CAD-3383/documentation branch from d334fc6 to 79316b7 Compare October 22, 2021 10:21
@EncodePanda
Copy link
Contributor Author

bors merge

1 similar comment
@EncodePanda
Copy link
Contributor Author

bors merge

@iohk-bors
Copy link
Contributor

iohk-bors bot commented Oct 24, 2021

Build succeeded:

@iohk-bors iohk-bors bot merged commit 7d65c5d into master Oct 24, 2021
@iohk-bors iohk-bors bot deleted the EncodePanda/CAD-3383/documentation branch October 24, 2021 16:59
coot pushed a commit that referenced this pull request May 16, 2022
@iohk-bors @EncodePanda
Merge #3435
975af4d 
3435: Add documentation for the db-analyser tool r=EncodePanda a=EncodePanda



Co-authored-by: EncodePanda <paul.szulc@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasagredo jasagredo jasagredo approved these changes

@nfrisby nfrisby nfrisby approved these changes

@dnadales dnadales Awaiting requested review from dnadales

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
@EncodePanda @nfrisby @jasagredo