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 gallery #204

Merged
merged 5 commits into from
Sep 6, 2018
Merged

README gallery #204

merged 5 commits into from
Sep 6, 2018

Conversation

ColCarroll
Copy link
Member

Some minor edits, but mostly adding a gallery to the readme.

Note that I am linking the images directly to the documentation, instead of internally into the github repo. This is a little risky (if the documentation goes down, the README looks bad), but makes the README portable: the images will still display on pypi, for example.

You can see it at https://github.com/ColCarroll/arviz/tree/pretty-docs

2. Clone this repo,
3. Run `./scripts/start_container.sh`

This should start a local docker container called arviz, as well as a Jupyter notebook server running on port 8888. The notebook should be opened in your browser automatically (you can disable this by passing --no-browser). The container will be running the code from your local copy of arviz, so you can test your changes.
Copy link
Member

Choose a reason for hiding this comment

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

I would add one line saying you should run tests, and also can lint code with ./lint.sh if desired

@canyon289
Copy link
Member

canyon289 commented Sep 6, 2018

You have one commit labels WIP. I think that could have a better commit message!

2b36757

@ColCarroll
Copy link
Member Author

Interesting - I had thought commits were getting squashed, but I see a few silly commit messages. Do you know an easy way to fix that? Maybe we default to doing "squash and merge"?

@canyon289
Copy link
Member

I believe thats the way to do it. There's these UI buttons. Squash and rebasing like pymc3 sounds reasonable to me

screen shot 2018-09-06 at 6 39 31 am

@canyon289 canyon289 merged commit dc954b0 into arviz-devs:master Sep 6, 2018
@aloctavodia
Copy link
Contributor

Agree "squash and merge" should be the default

@canyon289
Copy link
Member

I turned off the merge commit and rebase so there should only be one option now

@ahartikainen
Copy link
Contributor

git log --oneline

Check hash

git rebase -i <suitable-hash-here>

and the squash, and fixup if needed.

@ColCarroll ColCarroll deleted the pretty-docs branch January 30, 2021 02:53
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

4 participants