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

[lp_intro] update suggestions #474

Merged
merged 2 commits into from
Jul 3, 2024
Merged

[lp_intro] update suggestions #474

merged 2 commits into from
Jul 3, 2024

Conversation

longye-tian
Copy link
Collaborator

Dear John @jstac,

I have updated some of the lp_intro.md lecture according to #469 (mainly involving typos, and styles)

In particular, the changes include:

Code

  • round the print in the code

Typos and styles

  • Unbold non-definition words and use italics for emphases
  • Remove capitalization in the titles
  • Add period for the first sentence in example 1
  • use "ortools.linear_solver"
  • "... using it's status" -> "... using its status"
  • "three year" -> "three-year"
  • "Let's us" -> "Let's"
  • "LP" -> "Linear programming"
  • In the dot point in the "useful transformations" section, remove the capitalization of the second word.
  • 'bounds' -> bounds
  • We did not discuss complementary slackness, so we can delete it.

One thing I find is that the column header is automatically in bold, so I cannot fix it by changing the MD file.
For the suggestions related to materials, I will create a separate issue tracker and pull request.

Best ❤️
Longye

This pull request update some of the the lp_intro.md lecture according to #469 (mainly involving typos, styles)

In particular, the changes include:

- [x] Unbold non-definition words and use italics for emphases
- [x] Remove capitalization in the titles
- [x] Add period for the first sentence in example 1
- [x] use "`ortools.linear_solver`"
- [x] "... using it's status" -> "... using its status"
- Round the print in the format string for printing.
- "three year" -> "three-year"
- "Let's us" -> "Let's"
- "LP" -> "Linear programming"
- In the dot point in the "useful transformations" section, remove the capitalization of the second word.
- 'bounds' -> `bounds`
- We did not discuss complementary slackness, so we can delete it.

One thing I find is that the column header is automatically in bold, so I cannot fix it by changing the md file.
@longye-tian longye-tian requested review from jstac and mmcky June 26, 2024 07:08
Copy link

netlify bot commented Jun 26, 2024

Deploy Preview for taupe-gaufre-c4e660 ready!

Name Link
🔨 Latest commit 2c2187f
🔍 Latest deploy log https://app.netlify.com/sites/taupe-gaufre-c4e660/deploys/668345a6497e6f00086b5caa
😎 Deploy Preview https://deploy-preview-474--taupe-gaufre-c4e660.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Jun 26, 2024

@github-actions github-actions bot temporarily deployed to pull request June 26, 2024 07:14 Inactive
@github-actions github-actions bot temporarily deployed to pull request June 26, 2024 07:16 Inactive
@jstac
Copy link
Contributor

jstac commented Jun 27, 2024

Many thanks @longye-tian , this is much appreciated.

@mmcky , can you please review?

@mmcky
Copy link
Contributor

mmcky commented Jun 27, 2024

thanks @longye-tian

One thing I find is that the column header is automatically in bold

Is this in some code output? Or a part of the document?

@longye-tian
Copy link
Collaborator Author

thanks @longye-tian

One thing I find is that the column header is automatically in bold

Is this in some code output? Or a part of the document?

Hi Matt @mmcky ,

It is part of the markdown table, for example in the lp_intro.md, we have the following table,

Product 1 Product 2
Material 2 5
Labor 4 2
Revenue 3 4

The default setting in the md table is that the column header is in bold. I wish to unbold the column header as according to our style guide, the bold font is for definition. Do you know how to do that? Thank you Matt!

Best,
Longye

@mmcky
Copy link
Contributor

mmcky commented Jun 27, 2024

thanks @longye-tian

One thing I find is that the column header is automatically in bold

Is this in some code output? Or a part of the document?

Hi Matt @mmcky ,

It is part of the markdown table, for example in the lp_intro.md, we have the following table,

Product 1 Product 2
Material 2 5
Labor 4 2
Revenue 3 4
The default setting in the md table is that the column header is in bold. I wish to unbold the column header as according to our style guide, the bold font is for definition. Do you know how to do that? Thank you Matt!

Best, Longye

Thanks for explaining this @longye-tian. If this is part of the table rendering then that would be controlled by the theme.

@jstac would you like all table headers to be not bolded? It is common for them to be bolded but if that interferes with usage from our style guide then we should be able to update the style.

@jstac
Copy link
Contributor

jstac commented Jun 28, 2024

@mmcky @longye-tian Let's go with the default theme for marking up tables. It's best to stick with defaults when possible.

Thanks again @longye-tian and thanks @mmcky for the review. Merging.

@mmcky mmcky added the ready label Jun 30, 2024
Dear John @jstac,

This pull request finishes the issue #469 by

- add the notation for $z$, $A_{eq},b_{eq}, A_{ub},b_{ub}$.

- change the orange to black to correspond to the changes in the visualization plot.

Best,
Longye
@github-actions github-actions bot temporarily deployed to pull request July 2, 2024 00:18 Inactive
@github-actions github-actions bot temporarily deployed to pull request July 2, 2024 00:19 Inactive
@jstac jstac merged commit 39594d7 into main Jul 3, 2024
7 checks passed
@jstac jstac deleted the lp branch July 3, 2024 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants