Skip to content

Commit

Permalink
docs: code back-ticks to make Vale happier
Browse files Browse the repository at this point in the history
  • Loading branch information
tgaff committed Jul 7, 2023
1 parent e4b5993 commit e570a63
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
21 changes: 13 additions & 8 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,13 @@ The controller used for testing components.
Can also be configured on a per-test basis using `#with_controller_class`.
Defaults to `ApplicationController`.

### `.use_deprecated_instrumentation_name`

Whether ActiveSupport Notifications use the private name `"!render.view_component"`
or are made more publicly available via `"render.view_component"`.
Will default to `false` in next major version.
Defaults to `true`.

### `.view_component_path`

The path in which components, their templates, and their sidecars should
Expand Down Expand Up @@ -342,14 +349,6 @@ with_request_url("/users/42") do
end
```

To use a specific host, pass the host param:

```ruby
with_request_url("/users/42", host: "app.example.com") do
render_inline(MyComponent.new)
end
```

### `#with_variant(variant)`

Set the Action Pack request variant for the given block:
Expand All @@ -362,6 +361,12 @@ end

## Errors

### `AlreadyDefinedPolymorphicSlotSetterError`

A method called 'SETTER_METHOD_NAME' already exists and would be overwritten by the 'SETTER_NAME' polymorphic slot setter.

Please choose a different setter name.

### `ContentAlreadySetForPolymorphicSlotError`

Content for slot SLOT_NAME has already been provided.
Expand Down
6 changes: 3 additions & 3 deletions lib/view_component/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ def defaults

# @!attribute use_deprecated_instrumentation_name
# @return [Boolean]
# Whether ActiveSupport Notifications use the private name "!render.view_component"
# or are made more publicly available via "render.view_component".
# Will default to false in next major version.
# Whether ActiveSupport Notifications use the private name `"!render.view_component"`
# or are made more publicly available via `"render.view_component"`.
# Will default to `false` in next major version.
# Defaults to `true`.

# @!attribute render_monkey_patch_enabled
Expand Down

0 comments on commit e570a63

Please sign in to comment.