Skip to content

Omit doc safety/errors header checking for main #5023

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 1 commit into from
Jan 14, 2020
Merged

Omit doc safety/errors header checking for main #5023

merged 1 commit into from
Jan 14, 2020

Conversation

llogiq
Copy link
Contributor

@llogiq llogiq commented Jan 8, 2020

This omits checking main methods, which are not usually documented in the way the others are.

changelog: none

Copy link
Member

@phansch phansch left a comment

Choose a reason for hiding this comment

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

You could also use utils::is_entrypoint_fn which is a bit more generic and will work for any other other function marked with #[entry].

Also a test would be nice =)

@llogiq
Copy link
Contributor Author

llogiq commented Jan 14, 2020

I at least made the main() function return Result. No idea how I would test the other variants.

@phansch
Copy link
Member

phansch commented Jan 14, 2020

Yeah, that test should be enough, thanks!

@bors r+

@bors
Copy link
Contributor

bors commented Jan 14, 2020

📌 Commit 2797b64 has been approved by phansch

@bors
Copy link
Contributor

bors commented Jan 14, 2020

⌛ Testing commit 2797b64 with merge 5ab50d2...

bors added a commit that referenced this pull request Jan 14, 2020
Omit doc safety/errors header checking for main

This omits checking `main` methods, which are not usually documented in the way the others are.

changelog: none
@bors
Copy link
Contributor

bors commented Jan 14, 2020

☀️ Test successful - checks-travis, status-appveyor
Approved by: phansch
Pushing 5ab50d2 to master...

@bors bors merged commit 2797b64 into master Jan 14, 2020
@llogiq llogiq deleted the doc-main branch January 15, 2020 02:33
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.

3 participants