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.

Sign up for GitHub

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

Jump to bottom

Add guides to rbis #1228

Merged
merged 3 commits into from
Nov 2, 2022
Merged

Add guides to rbis #1228

merged 3 commits into from
Nov 2, 2022

Conversation

adisonlampert
Copy link
Contributor

Motivation

Worked on this during group pairing last week and today.
https://github.com/Shopify/ruby-dev-exp-issues/issues/642

Implementation

Added comments to create_method so that guides could be passed into RBI::Method.new which already takes comments as a parameter.

Screen Shot 2022-10-14 at 12 51 08 PM
This a screenshot from code-db in app/models/project.rb
Here, "Rails Guides" links to the official Rails guide on has_many associations since a project has_many snapshots.

Tests

Test haven't been updated yet.

Thoughts?

@adisonlampert adisonlampert changed the title Group pairing/add guides to rbis Add guides to rbis Oct 14, 2022
@egiurleo
Copy link
Contributor

Related to https://github.com/Shopify/ruby-dev-exp-issues/issues/658

@st0012
Copy link
Member

st0012 commented Oct 26, 2022

Since @adisonlampert is away this week, I'll continue this PR.

@st0012 st0012 self-assigned this Oct 26, 2022
@st0012 st0012 added the enhancement New feature or request label Oct 26, 2022
@st0012 st0012 force-pushed the group-pairing/add-guides-to-rbis branch 4 times, most recently from e9405a3 to aba75a9 Compare October 27, 2022 13:29
@st0012 st0012 force-pushed the group-pairing/add-guides-to-rbis branch 2 times, most recently from 1771593 to 95964ef Compare October 31, 2022 20:03
@st0012 st0012 marked this pull request as ready for review October 31, 2022 20:04
@st0012 st0012 requested a review from a team as a code owner October 31, 2022 20:04
Morriar
Morriar approved these changes Nov 1, 2022
View reviewed changes
sorbet/rbi/gems/[email protected] Outdated Show resolved Hide resolved
@st0012 st0012 force-pushed the group-pairing/add-guides-to-rbis branch from 95964ef to 1756f03 Compare November 1, 2022 16:25
vinistock
vinistock reviewed Nov 1, 2022
View reviewed changes
Copy link
Member

@vinistock vinistock left a comment

Choose a reason for hiding this comment

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

Do we have an issue for adding guide links to other parts of Rails (controllers, jobs, routes)?

spec/tapioca/dsl/compilers/active_record_associations_spec.rb Show resolved Hide resolved
@st0012
Copy link
Member

st0012 commented Nov 2, 2022

@vinistock For follow up tasks, I've created https://github.com/Shopify/ruby-dev-exp-issues/issues/675 for it.
And as an experiment, I also tried using a milestone to chain all the relevant issues together.

@st0012 st0012 force-pushed the group-pairing/add-guides-to-rbis branch from 1756f03 to b19e152 Compare November 2, 2022 15:36
@st0012 st0012 merged commit a9f3409 into main Nov 2, 2022
@st0012 st0012 deleted the group-pairing/add-guides-to-rbis branch November 2, 2022 17:41
@shopify-shipit shopify-shipit bot temporarily deployed to production November 10, 2022 17:34 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vinistock vinistock vinistock approved these changes

@st0012 st0012 st0012 left review comments

@Morriar Morriar Morriar approved these changes

@paracycle paracycle Awaiting requested review from paracycle

@egiurleo egiurleo Awaiting requested review from egiurleo

Assignees

@st0012 st0012

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@adisonlampert @egiurleo @st0012 @paracycle @Morriar @vinistock