Skip to content

Documentation should reflect reality #692

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

Closed
wants to merge 1 commit into from
Closed

Conversation

pboling
Copy link

@pboling pboling commented Jan 31, 2023

Documentation of created bin stub in README.md is wrong.

hooks Spring into the execution of commands. In other cases, the snippet
will just be silently ignored, and the lines after it will be executed as
normal.
This will cause the application to fail to load on platforms which do not install the Spring gem, e.g. Production.
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Author

Choose a reason for hiding this comment

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

I think I get it now. The documentation needs to be updated to reflect that^ and also to mirror the contents of the udpated bin stub... So this PR is not quite right, but there is an issue in the current readme in latest main branch, where it doesn't match what is being created as of #662.

@pboling
Copy link
Author

pboling commented Jul 20, 2023

Closing because this change is incorrect, but the README was also incorrect at this time. I'm not sure if the documentation has been, or will be, fixed to reflect reality.

@pboling pboling closed this Jul 20, 2023
@pboling pboling deleted the patch-1 branch July 20, 2023 03: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.

2 participants