-
-
Notifications
You must be signed in to change notification settings - Fork 53
[lqcontrol] Proofread and changed text to match the guidelines #609
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
Conversation
matheusvillasb
commented
Sep 11, 2025
- I also added a few lines of text to solve doubts that I had during the reading and that other readers could potentially have as well.
- For the coding part, should I change c_bar for c̄?
- The guideline says not to specify figsize unless necessary. Is this case unnecessary?
- The code seems easy and simple enough to convert to JAX to me. But it would be great to have a second opinion.
- Should I add a comment with the name of the parameters inside the code cells? I've seen this in some lectures, but it's not explicit in the guidelines.
This comment was marked as outdated.
This comment was marked as outdated.
@matheusvillasb thanks for this PR. The key issue is you have commited the document at the root level rather than replacing You should: You can also just move the file and then git add, git commit as usual. |
@matheusvillasb before you make changes to this branch you should
when on your |
📖 Netlify Preview Ready! Preview URL: https://pr-609--sunny-cactus-210e3e.netlify.app (6850297) |
📖 Netlify Preview Ready! Preview URL: https://pr-609--sunny-cactus-210e3e.netlify.app (d33cf0c) |
📖 Netlify Preview Ready! Preview URL: https://pr-609--sunny-cactus-210e3e.netlify.app (47571d9) |
@matheusvillasb I don't see any difference between
|
Hi @matheusvillasb, many thanks for working on this PR!
c̄ isn’t very easy to type in Jupyter notebooks, so we usually only change the Greek letters. For example:
In this case, I think it is necessary to have a stacked plot with the correct aspect ratio. The rule of thumb is whether removing If it doesn’t affect the quality of the figure or the message it conveys, we can remove it.
Yes, I agree. I don’t think we need to convert this. The rule of thumb is to check whether
Yes, if the parameters have specific meanings (for example, economic interpretations). But if they are simply taken from the formula without any extra layer of meaning, it’s fine to leave them as is. I hope this answers your questions! |
@matheusvillasb and I setup a new PR after reverting accidental commits to |