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

Undocument a bunch of expression methods, cf #1668 #3379

Closed
wants to merge 1 commit into from

Conversation

pzinn
Copy link
Contributor

@pzinn pzinn commented Jul 25, 2024

hopefully this reduces the number of undocumented methods, cf #1668

@mahrud
Copy link
Member

mahrud commented Jul 25, 2024

Ah, sorry I should have been clear that I'm already working on this on a branch, I just wanted to know if you have a particular preference about how to do it.

For instance, do you specifically want things like Sum + Sum to appear in the documentation (perhaps along with the documentation of +), or is it okay if we undocument all default operations on Expressions other than some exceptions? (e.g. denominator Divide, etc.)

@pzinn
Copy link
Contributor Author

pzinn commented Jul 25, 2024

well, you can see my proposed solution, that should answer your question

@mahrud
Copy link
Member

mahrud commented Jul 26, 2024

It doesn't really answer this question:

For instance, do you specifically want things like Sum + Sum to appear in the documentation (perhaps along with the documentation of +), or is it okay if we undocument all default operations on Expressions other than some exceptions? (e.g. denominator Divide, etc.)

Which nodes involving expressions do you think should be listed in the documentation?

@pzinn pzinn closed this Jul 28, 2024
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