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.

Sign up for GitHub

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

Jump to bottom

Extended documentation in README.md #47

Merged
merged 10 commits into from
Aug 20, 2024
Merged

Extended documentation in README.md #47

merged 10 commits into from
Aug 20, 2024

Conversation

santacodes
Copy link
Collaborator

I added a bit more documentation in README.md. I have yet to add the pybamm-cookie logo to the README and I will add it within this PR itself.

#26

@santacodes
Copy link
Collaborator Author

Also, I did not document about entry points as I was unsure if it should go in README or in actual pybamm docs upstream.

Saransh-cpp
Saransh-cpp requested changes Aug 18, 2024
View reviewed changes
Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

Thanks, @santacodes! A few comments below -

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@santacodes @Saransh-cpp
Apply suggestions from code review
1f6ab80 
Co-authored-by: Saransh Chopra <saransh0701@gmail.com>
agriyakhetarpal
agriyakhetarpal reviewed Aug 19, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
santacodes and others added 2 commits August 19, 2024 21:10
@santacodes @agriyakhetarpal
Apply suggestions from code review
2e5b05a 
Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
@santacodes
better here references
e7b0871
@santacodes santacodes mentioned this pull request Aug 19, 2024
Closed
16 tasks
arjxn-py
arjxn-py reviewed Aug 19, 2024
View reviewed changes
Copy link
Member

@arjxn-py arjxn-py left a comment

Choose a reason for hiding this comment

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

Thanks @santacodes, looks good.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
santacodes and others added 2 commits August 19, 2024 22:13
@santacodes @arjxn-py
Update README.md
0a65892 
Co-authored-by: Arjun Verma <arjunverma.oc@gmail.com>
@santacodes
added pytest commands for tests
171e8d4
Saransh-cpp
Saransh-cpp approved these changes Aug 19, 2024
View reviewed changes
Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

One final comment -

README.md Outdated Show resolved Hide resolved
@santacodes @Saransh-cpp
Update README.md
23ab297 
Co-authored-by: Saransh Chopra <saransh0701@gmail.com>
@santacodes santacodes merged commit 1b5e14e into pybamm-team:main Aug 20, 2024
84 checks passed
@santacodes santacodes deleted the doc branch August 30, 2024 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agriyakhetarpal agriyakhetarpal agriyakhetarpal approved these changes

@Saransh-cpp Saransh-cpp Saransh-cpp approved these changes

@brosaplanella brosaplanella brosaplanella approved these changes

@arjxn-py arjxn-py Awaiting requested review from arjxn-py

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@santacodes @brosaplanella @Saransh-cpp @agriyakhetarpal @arjxn-py