Document the constants in the socket module

Open
#45,048 17 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation, networking

Research direction

Start by reviewing the linked gh-132752 pull request and the doc-for-socket-af-constants.patch mentioned in the issue. Check which socket constants are already documented and which remain, including the listed dependencies. Done means the relevant socket module constants are documented without duplicating work covered elsewhere.

Written by the indexing model from the issue text.

Description

docs topic-socket type-feature
BPO 1732367
Nosy @birkenfeld, @giampaolo, @bitdancer, @vadmium, @ammaraskar
Dependencies
  • bpo-12887: Documenting all SO_* constants in socket module
  • bpo-13256: Document and test new socket options
  • bpo-14345: Document socket.SOL_SOCKET
  • bpo-27409: List socket.SO_, SCM_, MSG_, IPPROTO_ symbols
    		•
    Files
  • doc-for-socket-af-constants.patch
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = None
created_at = <Date 2007-06-06.20:46:18.000>
labels = ['type-feature', '3.7', 'docs']
title = 'Document the constants in the socket module'
updated_at = <Date 2017-08-12.12:12:03.630>
user = 'https://bugs.python.org/sonderblade'

    bugs.python.org fields:

    activity = <Date 2017-08-12.12:12:03.630>
actor = 'ammar2'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2007-06-06.20:46:18.000>
creator = 'sonderblade'
dependencies = ['12887', '13256', '14345', '27409']
files = ['8037']
hgrepos = []
issue_num = 1732367
keywords = ['patch']
message_count = 17.0
messages = ['52732', '52733', '52734', '52735', '59375', '66743', '66751', '67121', '116686', '116690', '269459', '272496', '299206', '300151', '300189', '300192', '300197']
nosy_count = 7.0
nosy_names = ['georg.brandl', 'sonderblade', 'giampaolo.rodola', 'bjourne', 'r.david.murray', 'martin.panter', 'ammar2']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue1732367'
versions = ['Python 3.7']

    Linked PRs
    • gh-132752
    Dominant language
    Python
    Stars
    77.2k
    Forks
    36k
    Avg merge
    1d 9h
    Merged PRs (30d)
    558

    Contributor guide

    Open the contributing guide

    First steps

    1. Read the whole issue, then the project's contributing guide.
    2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
    3. Fork the repository and make your change on a branch.
    4. Open a pull request that references the issue number.

    More from python/cpython

    All issues in python/cpython

    Similar issues

    More Python issues

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.