Skip to content

docs: enhance documentation support and resolve clippy warnings #81

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

Merged
merged 13 commits into from
Jun 11, 2023

Conversation

JarvisCraft
Copy link
Contributor

Description

This enhances documentation support by:

  • resolving existing docs issues:
    • invalid links;
    • missing # Safety sections
  • enabling automatic generation of # Features section;
  • resolving rustdoc and clippy warnings which were polluting the log.

@JarvisCraft
Copy link
Contributor Author

JarvisCraft commented Jun 8, 2023

It's worth noting that

[workspace.package.metadata.docs.rs]
all-features = true

in workspace root failed to work (this section seems to be ignored, at least for this specific field).

@JarvisCraft JarvisCraft force-pushed the enhance-docs-generation branch from c349688 to 57233a5 Compare June 8, 2023 14:45
@str4d str4d mentioned this pull request Jun 9, 2023
@JarvisCraft
Copy link
Contributor Author

JarvisCraft commented Jun 9, 2023

@str4d, I've merged the latest main so that it now should comply with changes from #83.

Copy link
Contributor

@str4d str4d left a comment

Choose a reason for hiding this comment

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

Generally LGTM

@JarvisCraft JarvisCraft requested a review from str4d June 10, 2023 11:35
@JarvisCraft
Copy link
Contributor Author

@str4d, I guess there are no more changes here and the CI seems to fail due to some external error

@str4d
Copy link
Contributor

str4d commented Jun 11, 2023

Yeah, I've been trying to figure out a way around it, but unfortunately (for good security reasons) GitHub doesn't allow workflows run on PRs from third-party repos to have any write permissions to the base repo. And the Clippy action I found does a small write at the start to create a status entry if it doesn't exist, and that is what is blocking the actual Clippy checks from running. I've opened auguwu/clippy-action#15 upstream for this, but if this can't be addressed easily there, then I'll look into an alternative approach.

Copy link
Contributor

@str4d str4d left a comment

Choose a reason for hiding this comment

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

ACK with a few cleanups.

@str4d str4d merged commit dd1ba2a into flipperzero-rs:main Jun 11, 2023
@JarvisCraft JarvisCraft deleted the enhance-docs-generation branch June 11, 2023 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants