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

Update docs for extraction_operator_linter() #1592

Merged
merged 2 commits into from
Oct 3, 2022

Conversation

IndrajeetPatil
Copy link
Collaborator

Closes #1584

Part of #1492

Comment on lines +4 to +8
#' used to improve readability, the solution should instead be to improve the
#' naming of the object to better indicate that its contents are logical. This
#' can be done using prefixes (is, has, can, etc.). For example, `is_child`,
#' `has_parent_supervision`, `can_watch_horror_movie` clarify their logical
#' nature, while `child`, `parent_supervision`, `watch_horror_movie` don't.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

To be consistent with the rest of the docs.

@MichaelChirico MichaelChirico merged commit 7f528d8 into main Oct 3, 2022
@MichaelChirico MichaelChirico deleted the 1584_extraction_op_docs branch October 3, 2022 03:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention safety-efficiency tradeoff in extraction_operator_linter() docs
2 participants