Skip to content

rename pg component to paragraph component #48

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

Merged
merged 2 commits into from
Jun 4, 2019

Conversation

pascalwengerter
Copy link
Contributor

Fixes #47

@jonasjabari
Copy link
Member

Thank you! Before merging this, we need to make sure, that users get informed about this breaking change. Either we provide backwards compatibility (leaving the pg component as is - next to the new paragraph component - for the next releases and add a warning when being used) or communicate this breaking change explicitly. I would prefer a structured and documented approach including terminated backwards compatibility. What do you think?

@pascalwengerter
Copy link
Contributor Author

Great thinking from your side. I have re-added the pg core component including tests and the docs, now mentioning its deprecation and linking the "new" paragraph component.

Maybe we should introduce a deprecation warning from the 0.7 relase on and remove it completely at the 0.8 release?

@jonasjabari jonasjabari merged commit d0757f3 into master Jun 4, 2019

Show [specs](../../spec/usage/components/paragraph_spec.rb)

The HTML `<p>` tag implemented in ruby. This is a workaround because the single `p` is the short version of `puts` in ruby.
Copy link

Choose a reason for hiding this comment

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

@PasWen actually p is a bit different from puts, it's not the short version. p calls .inspect on the printed object, puts not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey,
thanks for pointing it out, just fixed it in the documentation (and learned sth new on the way;)!

@pascalwengerter pascalwengerter deleted the change_paragraph_component branch June 21, 2019 07:34
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.

Rename or alias pg to paragraph
3 participants