Skip to content

Finalize JuMP README#312

Merged
pulsipher merged 7 commits intomasterfrom
jump-readme
May 4, 2023
Merged

Finalize JuMP README#312
pulsipher merged 7 commits intomasterfrom
jump-readme

Conversation

@pulsipher
Copy link
Collaborator

@pulsipher pulsipher commented May 3, 2023

This addresses the concerns of @odow raised in #311.

@odow: Any other concerns or suggestions?

@pulsipher pulsipher mentioned this pull request May 3, 2023
Closed
@odow
Copy link
Contributor

odow commented May 4, 2023

Let's wait for the preview. It's easy to miss things just looking at Markdown.

@codecov
Copy link

codecov bot commented May 4, 2023 •
edited
Loading

Codecov Report

Merging #312 (fef1625) into master (c280bf8) will not change coverage.
The diff coverage is n/a.

❗ Current head fef1625 differs from pull request most recent head d4d9244. Consider uploading reports for the commit d4d9244 to get more accurate results

@@           Coverage Diff           @@
##           master     #312   +/-   ##
=======================================
  Coverage   99.77%   99.77%           
=======================================
  Files          36       36           
  Lines        7099     7099           
=======================================
  Hits         7083     7083           
  Misses         16       16

@odow
Copy link
Contributor

odow commented May 4, 2023

The linter failed. Here are the errors:

  {"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 17, "column": 24}}}, "severity": "ERROR"}
  {"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 19, "column": 44}}}, "severity": "ERROR"}
  {"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 20, "column": 16}}}, "severity": "ERROR"}
  {"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 21, "column": 13}}}, "severity": "ERROR"}
  {"message": "[Google.Ordinal] Spell out all ordinal numbers ('1st') in text.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 22, "column": 3}}}, "severity": "ERROR"}
  {"message": "[Google.Units] Put a nonbreaking space between the number and the unit in '1s'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 22, "column": 3}}}, "severity": "ERROR"}
  {"message": "[Google.Exclamation] Don't use exclamation points in text.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 27, "column": 32}}}, "severity": "ERROR"}
  {"message": "[Google.Exclamation] Don't use exclamation points in text.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 47, "column": 35}}}, "severity": "ERROR"}

@odow
Copy link
Contributor

odow commented May 4, 2023

Here's the preview: https://jump.dev/JuMP.jl/previews/PR3343/packages/InfiniteOpt/

@pulsipher
Copy link
Collaborator Author

pulsipher commented May 4, 2023

Ok, the latest commit should fix the linter problems

@odow
Copy link
Contributor

odow commented May 4, 2023

Started a new doc build off jump-readme.

@odow
Copy link
Contributor

odow commented May 4, 2023

I think we're safe to skip a doc rebuild with that last commit 😄

odow
odow reviewed May 4, 2023
View reviewed changes
@odow
Copy link
Contributor

odow commented May 4, 2023

You could also change the opening sentence to

[InfiniteOpt.jl](https://github.com/infiniteopt/InfiniteOpt.jl) is a `JuMP` extension

@pulsipher
Copy link
Collaborator Author

pulsipher commented May 4, 2023

@odow: anything else before I merge this?

@pulsipher pulsipher merged commit 3f0653f into master May 4, 2023
@pulsipher pulsipher deleted the jump-readme branch May 4, 2023 01:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@odow odow odow approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@pulsipher @odow