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

Restore API documentation example for with_request_url's host param #1794

Conversation

rmacklin
Copy link
Collaborator

@rmacklin rmacklin commented Jul 7, 2023

What are you trying to accomplish?

Addresses #1771 (review)

It looks like this may have been inadvertently deleted by regenerating the API docs. That happened because this example was manually added directly in api.md in #1773, rather than in the corresponding YARD comment. To fix this, we've added the example to the YARD comment and regenerated the API docs.

I did not include a changelog entry since this is just basically just reverting an inadvertent change from the most recent PR.

It looks like this may have been inadvertently deleted in
231d4bb by regenerating the API docs.
That happened because this example was manually added directly in
`api.md` in 5decd07, rather than in the
corresponding YARD comment. To fix this, we've added the example to the
YARD comment and regenerated the API docs.
@joelhawksley joelhawksley merged commit f73592f into main Jul 7, 2023
32 of 33 checks passed
@joelhawksley joelhawksley deleted the restore-api-docs-example-for-with_request_url-host-parameter branch July 7, 2023 20:46
@joelhawksley
Copy link
Member

Thanks Richard! hope you are well ❤️

claudiob pushed a commit to claudiob/view_component that referenced this pull request Dec 22, 2023
…ViewComponent#1794)

It looks like this may have been inadvertently deleted in
231d4bb by regenerating the API docs.
That happened because this example was manually added directly in
`api.md` in 5decd07, rather than in the
corresponding YARD comment. To fix this, we've added the example to the
YARD comment and regenerated the API docs.
claudiob pushed a commit to claudiob/view_component that referenced this pull request Jan 3, 2024
…ViewComponent#1794)

It looks like this may have been inadvertently deleted in
231d4bb by regenerating the API docs.
That happened because this example was manually added directly in
`api.md` in 5decd07, rather than in the
corresponding YARD comment. To fix this, we've added the example to the
YARD comment and regenerated the API docs.
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