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

Add page on non-linear least squares solvers #19

Merged

Conversation

ojwoodford
Copy link
Contributor

No description provided.

@KronosTheLate
Copy link
Contributor

This looks amazing, thank you so much. I will pull this branch, build the website with your changes, and do a proper review as soon as I find the time. But at first glance, this looks like really good content - thanks a bunch.

@KronosTheLate
Copy link
Contributor

  1. Note on file-name: In the CONTRIBUTING file I wrote that "The filename should use underscores for spaces, have only lowercase letters, and match the title of the section as well as possible.". Do you find that guideline reasonable? If yes, the filename needs to change. But I will discuss combining the pages in the nest paragraph, so we can hold our horses on the file renaming.
  2. I have a feeling that the number of sections will blow up over time, and I am therefore interested in making fewer sections. It is no problem to have long sections with table of contents. How would you feed about making "Nonlinear Least Squares Solvers" a subsection in the nonlinear solver section, as opposed to giving it its own page?
  3. As a general note, I am a fan of having a few fluffy sentences. I do not know much on this subject, and find the current version quite dense. Can we add some fluff? Some light introduction and perhaps a simple example would go a long way.

@ojwoodford
Copy link
Contributor Author

I can change the file name to "nonlinear_least_squares_solvers.md", or have it as a subsection of nonlinear solvers. I don't mind which. Please let me know your preference.

I can embellish a little, but my style is to be concise, so if you want much more, I suggest you leave it as future work, either for yourself or someone else.

@KronosTheLate
Copy link
Contributor

I would prefer a subsection inside nonlinear solvers, and the embellishment you can muster. And then I think it should be merged!

@KronosTheLate
Copy link
Contributor

Should I put your content into the nonlinear solver page, and close this? We can then concider the "adding embellishment" a seperate issue.

@ojwoodford
Copy link
Contributor Author

@KronosTheLate I've made the changes requested.

@KronosTheLate KronosTheLate merged commit 6781894 into JuliaPackageComparisons:main Oct 25, 2023
@KronosTheLate
Copy link
Contributor

Great, thanks! I merged, made some minor changes to the heading-level, and added a table of contents. Thanks ^_^

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.

None yet

2 participants