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

Fix YARD warnings throughout core #2636

Merged
merged 3 commits into from
Mar 26, 2018
Merged

Conversation

jhawthorn
Copy link
Contributor

This fixes all YARD warnings and errors in core (mostly due to slightly wrong syntax).

It doesn't touch carton_mailer.rb, which has 3 warnings, but I intend to address them in a separate PR.

This avoids issues with tooling (like YARD) trying to parse this as
ruby, and getting confused when it encounters an erb tag.

.rb.tt is the extension Rails uses for these types of files.
This avoids issues with tooling (like YARD) trying to parse this as
ruby, and getting confused when it encounters an erb tag.

.rb.tt is the extension Rails uses for these types of files.
This fixes all YARD warnings and errors in core (mostly due to slightly
wrong syntax).

It doesn't touch carton_mailer.rb, which has 3 warnings, but I intend to
address them in a separate PR.
Copy link
Member

@tvdeyen tvdeyen left a comment

Choose a reason for hiding this comment

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

👍 generated docs locally. Works great!

Besides the carton_mailer I also get warnings for payment_method. But this can as well be tackled in a different PR

@jhawthorn jhawthorn merged commit f343c16 into solidusio:master Mar 26, 2018
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