Repository navigation
docs: say that none meaning skip is a condition inside the function - #9643
Merged
Merged
Conversation
PR #9631 had _log_note() return a note or None, where None meant 'add nothing'. Its PR description rated function structure green, because the guideline read as being about functions that do something. Add this case and an example to the guideline.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
syft-pr-reviewskill rates a PR against "Keep the condition for doing something in the caller", it previously missed a function that returns a value or None, where None means "skip this". For example, PR feat: say when a log shows only its first characters #9631 first had_log_note()return a note or None, and its PR description rated function structure 🟢. Now the guideline names this case, with an example: ask the question with a separate function, such aslog_is_truncated(), and keep theifin the caller.Guidelines
High level
Mid level
Low level
Security
No change.
Testing
pre-commit run --all-filespasses.Asana task