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

Show parameter defaults and typing in the base math section. #677

Closed
irm-codebase opened this issue Sep 8, 2024 · 2 comments · Fixed by #690
Closed

Show parameter defaults and typing in the base math section. #677

irm-codebase opened this issue Sep 8, 2024 · 2 comments · Fixed by #690
Milestone

Comments

@irm-codebase
Copy link
Contributor

irm-codebase commented Sep 8, 2024

Description

We should show the default values in the default math section.

These are surprisingly hard to find without directly going to the code, which is probably now what we want users to do.

image

Related links

Version

v0.7.0

Proposed change

Show the default in the base-math section.

I think ruff does it in a particularly nice way https://docs.astral.sh/ruff/settings/#extend
They show the default and the type of the variable. I do not think we need to add examples, though.

@irm-codebase irm-codebase changed the title Show defaults in the base math section. Show parameter defaults and typing in the base math section. Sep 8, 2024
@brynpickering
Copy link
Member

Good to see you recommend the ruff approach, because that's exactly what we do (without even knowing ruff does it)! See e.g. one of our decision variables. Parameter defaults should also be making their way through. Will need to investigate where they're getting lost.

@irm-codebase
Copy link
Contributor Author

Huh, I missed that decision variables had it...
So yeah, pretty much that, but for parameters!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants