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

Improve documentation #1304

Merged
merged 49 commits into from
Nov 19, 2024
Merged

Improve documentation #1304

merged 49 commits into from
Nov 19, 2024

Conversation

YigitElma
Copy link
Collaborator

@YigitElma YigitElma commented Oct 16, 2024

Resolves #1227
Resolves #1252
Resolves #1261
Resolves #1332

  • Make some clarifications to grid dev guide.

  • Add a notebook that summarizes how we solve equilibrium problem

  • Fix unavailable link in grid notebook

  • Add Windows and WSL instructions

  • Add an example compute function with additional kwarg

  • Fix the typos noticed during tutorial recording

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@YigitElma YigitElma added documentation Add documentation or better warnings etc. override codecov Override codecov labels Oct 16, 2024
@YigitElma YigitElma mentioned this pull request Oct 20, 2024
@YigitElma YigitElma self-assigned this Oct 28, 2024
@YigitElma YigitElma marked this pull request as ready for review October 30, 2024 21:31
@YigitElma YigitElma added the easy Short and simple to code or review label Nov 4, 2024
Copy link

review-notebook-app bot commented Nov 6, 2024

View / edit / reply to this conversation on ReviewNB

f0uriest commented on 2024-11-06T22:25:03Z
----------------------------------------------------------------

should make clear that the force residual is a function of x, and explain what A and b are.


docs/installation.rst Outdated Show resolved Hide resolved
f0uriest
f0uriest previously approved these changes Nov 13, 2024
unalmis
unalmis previously approved these changes Nov 16, 2024
docs/installation.rst Outdated Show resolved Hide resolved
@YigitElma
Copy link
Collaborator Author

One last review request sorry! Merge when you approve!

@dpanici dpanici merged commit 555a959 into master Nov 19, 2024
23 checks passed
@dpanici dpanici deleted the yge/docs branch November 19, 2024 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add documentation or better warnings etc. easy Short and simple to code or review override codecov Override codecov
Projects
None yet
4 participants