-
Notifications
You must be signed in to change notification settings - Fork 146
Documentation Improvements #2580
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
Conversation
|
@LisaBock and @remi-kazeroni Since there was an issue with trying to merge the main remote branch to my local branch where I am applying my edits, I created a new request which based on this original pull request: Orignal pull request. I hope now that this meets the requirements |
|
Thanks @stacristo, I think it was the simplest to open a new PR. I will take a look now. |
remi-kazeroni
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the work @stacristo! I think this PR is in good shape and helps improving the clarity of the documentation. I have suggested a couple of improvements, old typos to be fixed and a question to the UET. There is also one subsection that I think was erroneously deleted in this PR. Please let me know if you have any questions or doubts.
|
Dear @remi-kazeroni , I have implemented based on your recommendations and checked for typos. Hopefully, it can be merged now |
remi-kazeroni
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @stacristo! Thanks for the changes, the PR looks good to me now. I have pushed a couple of very minor changes to avoid overwriting bits of documentation not touched by this PR. I have left one last suggestion that you might want to consider.
LisaBock
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @stacristo for this!
|
If no further comments on this PR, I plan to merge it by tomorrow evening. |
Description
Implemented documentation improvements
Closes #2458
Links to documentation:
Before you get started
Checklist
It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.