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

Docs/issue 465 exclude spark tests information #485

Conversation

seb-afk
Copy link
Contributor

@seb-afk seb-afk commented Aug 14, 2020

Description

Why was this PR created?
Addresses #465. Feel free to adapt the sentence.

Development notes

  • Added sentence to markdown file.
  • Add a note in contributing.md.

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change and added my name to the list of supporting contributions in the RELEASE.md file
  • Added tests to cover my changes

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

  • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.

  • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorised to submit this contribution on behalf of the original creator(s) or their licensees.

  • I certify that the use of this contribution as authorised by the Apache 2.0 license does not violate the intellectual property rights of anyone else.

@seb-afk seb-afk requested a review from idanov as a code owner August 14, 2020 14:28
Copy link
Contributor

@921kiyo 921kiyo left a comment

Choose a reason for hiding this comment

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

Thank you for your feedback!

> *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

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 :)

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.

4 participants