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

Bugfix/no ref/correct constrain documentation #108

Closed
wants to merge 2 commits into from
Closed

Bugfix/no ref/correct constrain documentation #108

wants to merge 2 commits into from

Conversation

JulienBacquart
Copy link

I corrected the mix between 'maximum' and 'minimum' in the explanation of the function signature.

I also made another commit to make the description of what the function does clearer, I find the sentence "to not exceed ... a minimum value" a bit weird.

@hx2A
Copy link
Collaborator

hx2A commented Feb 6, 2024

Hi @JulienBacquart ! Thanks for noticing these errors. I agree the description is a bit weird and should improved.

Can you make this PR but against this file in the py5generator repo?

https://github.com/py5coding/py5generator/blob/main/py5_docs/Reference/api_en/Sketch_constrain.txt

The reason behind this is a bit confusing. The py5generator repo generates the py5 code and the py5 reference documentation. I don't write either directly. All of the library docstrings and the website's reference documentation are generated from the data files in that directory. It is important that it be this way because py5 is generated from the Processing jars. I can't put docstrings at the top of the function source code like you would see for every other Python project.

I realize this unexpected and is different from other Python projects. If you make the PR for that other file, I'll regenerate the documentation which will update the file in this PR and also update the docstring in the actual py5 library.

@JulienBacquart
Copy link
Author

Ok, no problem, done: py5coding/py5generator#416

@hx2A
Copy link
Collaborator

hx2A commented Feb 7, 2024

The website has now been updated.

https://py5coding.org/reference/sketch_constrain.html

Thanks!

@hx2A hx2A closed this Feb 7, 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