René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Improve documentation for `pprint` module","articleBody":"# Documentation\r\n\r\nThe documentation for the `pprint` module could be improved in many respects:\r\n- Most users will probably only ever need to use `pprint.pp()` or `pprint.pprint()`, but these are buried halfway down the module. It would be nice if these were the first things on the page.\r\n- All examples in the documentation use `pprint.pprint()`, which has some unexpected behaviour. For example, it sorts dictionaries by default, which is somewhat unintuitive now that dictionaries maintain insertion order. I suggest we change the examples to use `pprint.pp()` instead, which has the more intuitive default of `sort_dicts=False`.\r\n- Similarly, the docs for `pprint.pprint()` could explicitly call out that it has unintuitive defaults for things such as `sort_dicts` and link to `pprint.pp()`\r\n- Some links in the module's documentation incorrectly point to the module itself (`pprint`) instead of the function `pprint.pprint()`.\r\n\r\nThese don't all necessarily need to be tackled in the same PR\r\n\r\n\u003c!-- gh-linked-prs --\u003e\r\n### Linked PRs\r\n* gh-116019\r\n* gh-116061\r\n* gh-116064\r\n* gh-116085\r\n* gh-116104\r\n* gh-116382\n* gh-116383\n* gh-116614\n* gh-117196\n* gh-117197\n* gh-117401\n* gh-117403\n* gh-118146\n* gh-121098\n* gh-121099\n\u003c!-- /gh-linked-prs --\u003e\r\n","author":{"url":"https://github.com/AlexWaygood","@type":"Person","name":"AlexWaygood"},"datePublished":"2024-02-27T10:11:05.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":15},"url":"https://github.com/115986/cpython/issues/115986"}