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

Clarifying formquad docstring #118

Merged
merged 5 commits into from
Dec 8, 2023
Merged

Clarifying formquad docstring #118

merged 5 commits into from
Dec 8, 2023

Conversation

jmlarson1
Copy link
Collaborator

Formquad supports npmax=n+1. Also, the models are at xkin.

@jmlarson1 jmlarson1 requested a review from mmenickelly December 8, 2023 17:34
@coveralls
Copy link

coveralls commented Dec 8, 2023

Pull Request Test Coverage Report for Build 7145728007

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 96.855%

Totals Coverage Status
Change from base Build 7051375403: 0.0%
Covered Lines: 1386
Relevant Lines: 1431

💛 - Coveralls

Copy link
Collaborator

@mmenickelly mmenickelly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The npmax clarification makes sense, but why is "xkin" better than "Xk" in the description for G and H?

@jmlarson1
Copy link
Collaborator Author

The npmax clarification makes sense, but why is "xkin" better than "Xk" in the description for G and H?

I was thinking because xkin is declared on line 19 it is clearer. Otherwise, Xk isn't used anywhere else in the docstring, right? (I can remove that edit if you prefer.)

@jmlarson1
Copy link
Collaborator Author

That wording is even better. Thanks @mmenickelly

@jmlarson1 jmlarson1 merged commit 966def1 into main Dec 8, 2023
21 checks passed
@jmlarson1 jmlarson1 deleted the formquad_doc branch December 8, 2023 20:07
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.

3 participants