René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"DOC: Best practice when to use ax.set_thing(foo) vs ax.set(thing=foo)","articleBody":"### Documentation Link\r\n\r\n_No response_\r\n\r\n### Problem\r\n\r\nInspired through the discussion at https://github.com/matplotlib/matplotlib/pull/28677#discussion_r1708863650: Through #20569 we have made `Artist.set()` more useable. In particular, we have started to `Axes.set()` in some places in the documentation.\r\n\r\nWe currently do not have a best practice when to `ax.set_thing(foo)` vs `ax.set(thing=foo)`.\r\n\r\n### Suggested improvement\r\n\r\nWe should have a best practive when to use what that we document, teach and use in our docs.\r\n\r\nThere was a loose discussion at https://github.com/matplotlib/ProjectManagement/blob/b9b0a56cb7b329c3c2adfac77a84975f70868e24/meeting_notes/2021/q2.md#do-we-want-to-soup-up-and-advertise-objset-more, but no definitive solution.\r\n\r\nGeneral observations:\r\n- Both APIs are intended to co-exist. We don't plan to get rid of one or the other.\r\n- Advantages of `set_thing()`:\r\n  - more specific\r\n  - easier to find the docs (for `set(thing=...)` one has to go to `set()` and follow the link for the specific keyword).\r\n  - more functionality through kwargs available\r\n- Advantages of `set(thing=...)`:\r\n  - shorter\r\n- Neutral\r\n  - tab completion should work for both cases (`ax.set_\u003cTAB\u003e` and `ax.set(\u003cTAB\u003e`)\r\n  - API is fully documented for both cases (no more `set(**kwargs)` signatures)\r\n  - Historically `set_thing` was mostly used and advertized\r\n \r\n\r\nPlease add if you have additional points.\r\n\r\nI'll stop here without suggesting a solution to keep the discussion unbiased. Suggestions for solution should be posted as separte comments.","author":{"url":"https://github.com/timhoffm","@type":"Person","name":"timhoffm"},"datePublished":"2024-08-09T14:09:54.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/28693/matplotlib/issues/28693"}