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.

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

docs and accounts #241

Merged
merged 2 commits into from
Sep 5, 2023
Merged

docs and accounts #241

merged 2 commits into from
Sep 5, 2023

Conversation

richardpringle
Copy link
Contributor

  • Make sure cargo doc runs on private items too
  • Remove remnants for ETH feature

@richardpringle richardpringle force-pushed the docs-and-accounts branch 2 times, most recently from 6148f80 to 4d5ba26 Compare September 1, 2023 15:12
xinifinity
xinifinity previously approved these changes Sep 1, 2023
@xinifinity xinifinity dismissed their stale review September 1, 2023 17:09

tests failing

run: cargo rustdoc -p firewood --lib -- -D rustdoc::broken-intra-doc-links
- name: Lint missing crate-level docs
run: cargo rustdoc -p firewood --lib -- -D rustdoc::missing-crate-level-docs
- run: RUSTDOCFLAGS="-D warnings" cargo doc --all --document-private-items
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should add --no-deps

Copy link
Collaborator

Choose a reason for hiding this comment

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

+1 for --no-deps

run: cargo rustdoc -p firewood --lib -- -D rustdoc::broken-intra-doc-links
- name: Lint missing crate-level docs
run: cargo rustdoc -p firewood --lib -- -D rustdoc::missing-crate-level-docs
- run: RUSTDOCFLAGS="-D warnings" cargo doc --all --document-private-items
Copy link
Collaborator

Choose a reason for hiding this comment

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

+1 for --no-deps

@richardpringle
Copy link
Contributor Author

waiting on #245

@richardpringle
Copy link
Contributor Author

I made changes, so no longer waiting on #245... But I renamed e2e so the "checks" are waiting for a job that's not going to run

@rkuris rkuris merged commit 5e2d746 into main Sep 5, 2023
@rkuris rkuris deleted the docs-and-accounts branch September 5, 2023 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants