René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Improve the documentation for `ignore_warnings`","articleBody":"# Documentation\r\n\r\nRecently, I found that using `ignore_warnings(*, category)`, a simple decorator in `test.support.warning_helper`, is sometimes a concise way to suppress warnings in test cases. For example:\r\n\r\n```python\r\n# use `with` statement\r\ndef test_suppress_warning():\r\n    with warnings.catch_warnings():\r\n        warnings.simplefilter(\"ignore\", category=SyntaxWarning)\r\n        # do something\r\n\r\n# use decorator\r\n@warning_helper.ignore_warnings(category=SyntaxWarning)\r\ndef test_suppress_warning():\r\n    # do something\r\n```\r\n\r\n**What I want to improve:**\r\n\r\n1. The [comment](https://github.com/python/cpython/blob/e375bff03736f809fbc234010c087ef9d7e0d384/Lib/test/support/warnings_helper.py#L47) of function `ignore_warnings` , it writes\r\n\r\n\u003e Decorator to suppress deprecation warnings\r\n\r\n But in fact this can become a more general warning suppression decorator, not just deprecation warnings, we can improve this comment. \r\n\r\n2. The document of [test.support.warnings_helper](https://docs.python.org/3.12/library/test.html?highlight=warnings_helper#module-test.support.warnings_helper), it is missing information about the function `ignore_warnings`.\r\n3. Perhaps we can also add a default value to it, just like `ignore_warnings(*, category=Warning)`, so that the behavior of this decorator is consistent with `warnings.simplefilter`.\r\n\n\n\u003c!-- gh-linked-prs --\u003e\n### Linked PRs\n* gh-103110\n* gh-103198\n* gh-103199\n\u003c!-- /gh-linked-prs --\u003e\n","author":{"url":"https://github.com/CharlieZhao95","@type":"Person","name":"CharlieZhao95"},"datePublished":"2023-03-29T11:18:38.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/103109/cpython/issues/103109"}