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

copy effects key to Base.infer_effects #56363

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

MasonProtter
Copy link
Contributor

Copied from the docstring of Core.Compiler.Effects, this makes it easier to figure out what the output of Base.infer_effects is actually telling you.

@MasonProtter MasonProtter added docs This change adds or pertains to documentation compiler:effects effect analysis labels Oct 28, 2024
Copy link
Member

@topolarity topolarity left a comment

Choose a reason for hiding this comment

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

It's embarrassing to admit how many times I've had to hunt for this

@giordano
Copy link
Contributor

I'm not against having this information in this docstring, but I'm worried about the duplication and the possibility of this information to get out-of-sync, at some point someone will miss to update it everywhere, since it's highly non-obvious it's repeated in multiple places.

@Keno
Copy link
Member

Keno commented Oct 29, 2024

Yeah, let's only have one place in the source code and paste it into the places that need it. I don't know if we have that feature in the Base doc system, but if not I guess we can hack something

@MasonProtter
Copy link
Contributor Author

Okay, I've de-duplicated the information into a global variable and then interpolated it into the two respective docstrings. There's probably a more elegant way to do this but that's what I came up with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler:effects effect analysis docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants