Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1157 +/- ##
=======================================
Coverage 98.62% 98.62%
=======================================
Files 27 27
Lines 3553 3553
Branches 561 561
=======================================
Hits 3504 3504
Misses 17 17
Partials 32 32
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
CodSpeed Performance ReportMerging #1157 will not alter performanceComparing Summary
Benchmarks breakdown
|
webknjaz
left a comment
There was a problem hiding this comment.
Fixture names and identifiers are long for the sake of readability. Short abbreviations are more difficult to decode.
|
The programming world is full of short names and abbreviations. All these short names are pretty readable and maintainable. Moreover, I personally found that |
|
@bdraco @Dreamsorcerer guys, please share your opinion on the raised question, do you prefer short abbreviated names in tests or as-long-as-possible ones? |
bdraco
left a comment
There was a problem hiding this comment.
I’ve definitely experienced this problem before, where the data becomes really difficult to read on smaller screens because of its length. I completely understand that everyone has different perspectives on the best way to handle it, and it’s unlikely we’ll get full alignment across the board.
Personally, given that I have limited time both on desktop and overall, I tend to favor changes that make it easier to contribute from mobile devices. From that perspective, I’m supportive of this change since it helps improve accessibility.
|
I try to aim to be concise, but unambiguous. It's easy to go too far in either direction. The changes in this PR don't seem to make a significant difference to me, so I don't mind either way (I might err slightly to leaving the current state, just to avoid git blame noise). |
|
I agree with Nick's assessment of difficulties present on devices with insufficient screen estate. That's one of the reasons I tend to insist on short lines. I also often use shorter identifiers in various UI labels (like GHA). Shortcuts are sometimes acceptable. Like in cases of commonly known terms/abbreviations (MD is a medical doctor, right? Everybody knows that!). In this case, however, other contexts should be taken into account too. The fixtures already contain one abbreviation (CI for continuous integration, huh? 😉). And that is already somewhat questionable. But at least it matches the actual class names. Adding a chain of abbreviations is definitely not readable. Sure, it might degrade some Æstetics a little bit. But what about other places where readability counts? We cnt jst strt drppn lttrs bcs o' 1 sngl tbl on gh. I think this would penalize maintainability long-term at the cost of a short-term satisfaction. |
|
Maybe short fixture names and comprehensive docstrings could provide a good enough compromise? |
|
The docstrings should always be verbose so that But that doesn't really fix the problem of a series of abbreviations being used in disconnected contexts because it adds mental overhead affecting when consuming the thing. Code is read much more often than it's being written, and for that reason it's important to optimize for the reading experience. The readers aren't just 1–2 people in the inner circle, and I was optimizing for inclusivity rather than creating entry barriers for potential contributors. I'm in favor of making names shorter where this doesn't compromise readability. |
|
We have an agreement for |
|
|
|
@webknjaz are you kidding me? We have a total of 58 contributors over the past 10 years, including the project admins. 95% of contributors made fewer than 10 commits throughout the entire history. I don't think anybody will suffer after the change. |
Long names don't fit the benchmarks UI; short versions are better and still readable.