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

Docs/issue 465 exclude spark tests information #485

Merged
merged 3 commits into from
Aug 17, 2020
Merged

Docs/issue 465 exclude spark tests information #485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
204c207
Close #465 Add info in excluding spark tests
seb-afk Aug 14, 2020
94d079d
Added name to the list of supporting contributions
seb-afk Aug 14, 2020
7ec5886
Merge branch 'master' into docs/issue-465-exclude-spark-tests-informa…
seb-afk Aug 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ make test
make build-docs
```

> *Note:* If the tests in `tests/extras/datasets/spark` are failing, and you are
> not planning to work on Spark related features, then you can run a reduced
> test suite that excludes them. Do this by executing the following command:
> `make test-no-spark`.
Copy link
Contributor

Choose a reason for hiding this comment

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

You will need to leave a blank line between "...command:" and the code block, otherwise it will not render.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You mean you would like it to render as a separate code block instead of inline?

Copy link
Contributor

Choose a reason for hiding this comment

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

Please. If you have a colon introducing the code, I'd expect to see a separate code block.

Otherwise I'd expect it to read "Do this by executing make test-no-spark." without any extra words like following. If it's inline, it's not following.

Copy link
Contributor Author

@seb-afk seb-afk Aug 18, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I like your "Do this by executing make test-no-spark" suggestion! Should I use that or would you like to change it directly? P.S. As mentioned in the PR description please feel free to change things directly if you have better formulations. I am not a native English speaker nor a professional writer. 😄

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks! OK, I'll make this change when I next go into the docs and it'll filter through in due course :)


#### Then onwards (code or documentation changes)

If you picked up a code or documentation related issue, before pushing the branch to the repo and creating a Pull Request please do the below:
Expand Down
2 changes: 2 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

## Thanks for supporting contributions

[Sebastian Bertoli](https://github.com/sebastianbertoli)

# Release 0.16.4

## Major features and improvements
Expand Down