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

Add harsher linting rules. #2

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add harsher linting rules. #2

wants to merge 10 commits into from

Conversation

ivajon
Copy link

@ivajon ivajon commented Mar 21, 2024

Add harsher linting rules

This PR adds harsher linting rules and ensures that the crate still builds by resolving the errors encountered. To ensure that future code contributions adhere to the standards and that future code contains valid or at least not broken documentation.

Future linting additions and modifications

I think that it would be good to remove the

#![allow(rustdoc::missing_crate_level_docs)]

linting rule and adding top-level documentation for the crate.
Moreover, I think that the crate also should include the lining rule

#![deny(missing_docs)]

But as I do not have full insight into what every part of the crate does I left that one for the future.

Testing

This PR has been tested by running the normal test suite after modifications.

Merging

This PR depends on #1 and is also a precursor to future inclusions of V7M functionality.

@s7rul
Copy link
Owner

s7rul commented Mar 24, 2024

I think all of this is good going forward, to keep in mind is that there might be a couple of functions in symex_lib that should not appear in the documentation and it might be the case that these must remain public for linking reasons but will look into whats the case.

Will wait to merging this before #1 is ready.

@ivajon ivajon mentioned this pull request May 5, 2024
10 tasks
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