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

Document generated scopes for has_one_attached and has_many_attached #48627

Merged
merged 1 commit into from
Jul 3, 2023

Conversation

p8
Copy link
Member

@p8 p8 commented Jul 2, 2023

has_one_attached and has_many_attached generate several scopes and relations:

  • with_attached_*
  • *_attachment
  • *_attachments
  • *_blob
  • *_blobs

But these are all undocumented.

We can document these methods similar to ee58c8e using the :method: directive.

image

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

`has_one_attached` and `has_many_attached` generate several scopes and
relations:

* `with_attached_*`
* `*_attachment`
* `*_attachments`
* `*_blob`
* `*_blobs`

But these are all undocumented.

We can document these methods similar to ee58c8e using the
`:method:` directive.
@p8 p8 merged commit 5694f1e into rails:main Jul 3, 2023
8 of 9 checks passed
@p8 p8 deleted the activestorage/document-with-attached branch July 3, 2023 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants