Fix the documentation warnings #3879
Conversation
Previously, things like `awful.screenshot` would print a false positive warning because the `item.name` was fixed after the linting rather than before it.
Those were written before the doc linting was merged.
They can now use multiple files. Some of the templates are getting unmaintainable and would benefit from being multiple small widgets.
Previously, it would raw_set properties like floating. This means the
signals and the result of calling `awful.client.property.get` was
different. Some older code uses `awful.client.property.get` or
`awful.client.object.get_floating` rather than `c.floating`.
With this change, all native properties should be handled as so
and all non native properties set at the end, after `__newindex`
is defined.
The list of properties was extracted using
cat client.c
| tail -n100
| grep -Eo '["][^"]+["]'
| grep -Eo '[^"]+'
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3879 +/- ##
=======================================
Coverage 91.01% 91.02%
=======================================
Files 901 901
Lines 57566 57609 +43
=======================================
+ Hits 52392 52436 +44
+ Misses 5174 5173 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
|
I will merge this soon because it's a doc only change and getting rid of those warning makes foxing other bugs easier |
mb then CI should fail on such warnings, to prevent it in the future? |
That would still not prevent such a PR from being merged, since CI runs on commit push, not on merge. Also known as "merge skew" or "semantic merge conflicts". |
we had both before, when using Travis - but didn't moved to the current setup, idk if that was a purpose choice or just an overlook during the migration |
|
What Travis did doesn't help here. Travis does merge the newly pushed commits into the base branch, but the crucial part is, it does it at the time of the push. That still doesn't cover the issue here of
Merge queues trigger at that |
They were added because the PRs which added those APIs predated the warnings, but were merged later.
And also fix some rendering bugs caused by the shims not behaving correctly.