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

ReadMe for consctructors #329

Merged
merged 33 commits into from
Jul 26, 2023
Merged

ReadMe for consctructors #329

merged 33 commits into from
Jul 26, 2023

Conversation

JaimeRZP
Copy link
Member

Updated ReadMe to explain how to use the constructors.
I also spotted a bug in the latest PR and added some tests so it doesn't go unnoticed in the future.

@JaimeRZP JaimeRZP mentioned this pull request Jul 21, 2023
2 tasks
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@torfjelde torfjelde left a comment

Choose a reason for hiding this comment

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

Good stuff:) Added a few comments.

Also, have we added docs (not in the README, but in docs/) for this?

IMO we should just move all the stuff in the README to docs/ anyways, though this should be done in a separate PR (but in this scenario, it might be worth just moving the section on the convenience contsructors to docs/ maybe?)

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
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Tor Erlend Fjelde <[email protected]>
@JaimeRZP
Copy link
Member Author

Thanks a lot @torfjelde. All good my plan is to merge this and make a release so we can bump the version on Turing!

@JaimeRZP
Copy link
Member Author

Good stuff:) Added a few comments.

Also, have we added docs (not in the README, but in docs/) for this?

IMO we should just move all the stuff in the README to docs/ anyways, though this should be done in a separate PR (but in this scenario, it might be worth just moving the section on the convenience contsructors to docs/ maybe?)

Made an issue about it #330

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
src/abstractmcmc.jl Outdated Show resolved Hide resolved
yebai
yebai previously approved these changes Jul 26, 2023
Copy link
Member

@yebai yebai left a comment

Choose a reason for hiding this comment

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

I made a few typo fixes and edits. Otherwise it looks very good to me!

test/constructors.jl Outdated Show resolved Hide resolved
yebai and others added 3 commits July 26, 2023 12:28
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* no init_e

* format

* bug

* Bugfix. (#337)

* Bugfix.

* Update src/constructors.jl

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update test/abstractmcmc.jl

* Update src/abstractmcmc.jl

Co-authored-by: Hong Ge <[email protected]>

---------

Co-authored-by: Hong Ge <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
test/constructors.jl Outdated Show resolved Hide resolved
test/constructors.jl Outdated Show resolved Hide resolved
test/constructors.jl Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
src/abstractmcmc.jl Outdated Show resolved Hide resolved
test/constructors.jl Outdated Show resolved Hide resolved
test/constructors.jl Outdated Show resolved Hide resolved
yebai
yebai previously approved these changes Jul 26, 2023
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
src/constructors.jl Outdated Show resolved Hide resolved
src/constructors.jl Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@yebai yebai merged commit e302429 into master Jul 26, 2023
@delete-merged-branch delete-merged-branch bot deleted the ReadMe_constructors branch July 26, 2023 19:00
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