Skip to content

YARD fixes + UserSortable concern - #2120

Open
Oaphi wants to merge 5 commits into
developfrom
0valt/docs-fixes
Open

YARD fixes + UserSortable concern #2120
Oaphi wants to merge 5 commits into
developfrom
0valt/docs-fixes

Conversation

@Oaphi

@Oaphi Oaphi commented Jul 30, 2026

Copy link
Copy Markdown
Member

Additional manual testing requested: sorting of logs and posts (just that it still works as expected)

@Oaphi
Oaphi requested a review from ArtOfCode- July 30, 2026 23:25
@codecov

codecov Bot commented Jul 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.98%. Comparing base (48d3e1c) to head (2f78611).

Additional details and impacted files
Components Coverage Δ
controllers 76.79% <ø> (-0.04%) ⬇️
helpers 85.47% <ø> (ø)
jobs 77.43% <ø> (ø)
models 93.20% <100.00%> (+0.04%) ⬆️
tasks 61.11% <ø> (ø)

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Oaphi added 2 commits July 31, 2026 02:51
It confuses the heck out of YARD + aligns it with other model concerns +
removed the need to disable the "1 class per file" rule of Rubocop
@Oaphi
Oaphi requested review from cellio and trichoplax July 31, 2026 00:00
@Oaphi Oaphi changed the title Minor fixes to YARD according to the tool's output YARD fixes + UserSortable concern Jul 31, 2026
@Oaphi
Oaphi force-pushed the 0valt/docs-fixes branch from bcbf525 to fb1fd90 Compare July 31, 2026 02:31
@Oaphi
Oaphi force-pushed the 0valt/docs-fixes branch from fb1fd90 to 2f78611 Compare July 31, 2026 02:34

@cellio cellio left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Don't rely just on me, but this looks good to me. That weird "align=center" thing on the landing page was there before too; I don't know what's causing it, but it's not a regression.

I reviewed only the doc, not the part where you moved UserSortable into a concern.

extend ActiveSupport::Concern

class_methods do
# Sort a collection according to a user selection, by mapping user selectable values to column names.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not super-familiar with how all this is wired together, but should this have turned into doc at https://docs.dev.codidact.org/docs/UserSortable? Or am I looking in the wrong place?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

No clue, those are concerns with class_methods instead of included - that's likely a limitation of yardoc. I can take a look just in case, but pretty sure that's not an issue on our side

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah, different type of method. I don't think we need to fuss over it; I was just trying to figure out if there was an error in either the content or the build setup that we were tripping over. Not that, so fine with me.

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