YARD fixes + UserSortable concern - #2120
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
Additional manual testing requested: sorting of logs and posts (just that it still works as expected)