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

Remove duplication of prerequisites and testing in docs #1596

Merged
merged 3 commits into from
Aug 3, 2023

Conversation

BenSturmfels
Copy link
Contributor

No description provided.

@BenSturmfels
Copy link
Contributor Author

I've assumed bin/rails spec is preferred over bundle exec rspec as that's what's in README.md. Is that right?

@BenSturmfels
Copy link
Contributor Author

Unrelated point - I think it would make sense to move all the detailed local development install and configure docs to docs/getting_started.md and leave README.rst as an overview of the project, how to get involved etc. What do you think?

@wwahammy
Copy link
Member

I've assumed bin/rails spec is preferred over bundle exec rspec as that's what's in README.md. Is that right?

So, it depends :)

Quick point: bin/rails spec and bundle exec rails spec are practically identical, the bin version actually calls the bundle execversion. Same withbin/rspecandbundle exec rspec`.

If you're running the test suite, bin/rspec and bin/rails spec should be identical I think. The only exception is if the test database isn't setup already, bin/rails spec will do that on first run. On the other hand bin/rspec provides all of the features of rspec. The major one I like is --only-failures which will run only failed tests from the last complete test run.

--next-failure is similar and will run failed tests from the last complete test run and stop at the first failure. Additionally, it will skip any tests which you've gotten working on a previous --next-failure run. It's really helpful for going through broken tests in turn.

I hope that helps!

Copy link
Member

@wwahammy wwahammy left a comment

Choose a reason for hiding this comment

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

I have one tweak I'd like made but otherwise this is very helpful!

README.md Show resolved Hide resolved
@wwahammy
Copy link
Member

Unrelated point - I think it would make sense to move all the detailed local development install and configure docs to docs/getting_started.md and leave README.rst as an overview of the project, how to get involved etc. What do you think?

I'm open to the idea. I tend to prefer it in the main README but I'm fine either way.

@BenSturmfels
Copy link
Contributor Author

Quick point: bin/rails spec and bundle exec rails spec are practically identical, the bin version actually calls the bundle execversion. Same withbin/rspecandbundle exec rspec`.

If you're running the test suite, bin/rspec and bin/rails spec should be identical I think. The only exception is if the test database isn't setup already, bin/rails spec will do that on first run. On the other hand bin/rspec provides all of the features of rspec. The major one I like is --only-failures which will run only failed tests from the last complete test run.

--next-failure is similar and will run failed tests from the last complete test run and stop at the first failure. Additionally, it will skip any tests which you've gotten working on a previous --next-failure run. It's really helpful for going through broken tests in turn.

Thanks, I've mentioned this in a subsequent commit.

@BenSturmfels
Copy link
Contributor Author

Unrelated point - I think it would make sense to move all the detailed local development install and configure docs to docs/getting_started.md and leave README.rst as an overview of the project, how to get involved etc. What do you think?

I'm open to the idea. I tend to prefer it in the main README but I'm fine either way.

No worries - I'll leave as-is for now.

Copy link
Member

@wwahammy wwahammy left a comment

Choose a reason for hiding this comment

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

Thanks @BenSturmfels!

@wwahammy wwahammy merged commit 4cea458 into houdiniproject:main Aug 3, 2023
19 checks passed
@BenSturmfels BenSturmfels deleted the docs branch August 24, 2023 23:49
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

2 participants