[doc] smtplib: add low-level APIs to doc?

Open
#59,218 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Review the smtplib documentation and the linked issue15013.patch from BPO issue 15013. Identify which low-level APIs the patch addresses and compare them with the current documentation. Done means the relevant low-level smtplib APIs are documented consistently and the documentation build passes.

Written by the indexing model from the issue text.

Description

3.11 docs topic-email type-feature
BPO 15013
Nosy @warsaw, @terryjreedy, @bitdancer, @sandrotosi, @rooterkyberian
Files
  • issue15013.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 2012-06-06.07:44:22.487>
labels = ['3.11', 'type-feature', 'expert-email', 'docs']
title = '[doc] smtplib: add low-level APIs to doc?'
updated_at = <Date 2021-12-06.14:40:30.541>
user = 'https://github.com/sandrotosi'

    bugs.python.org fields:

    activity = <Date 2021-12-06.14:40:30.541>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'email']
creation = <Date 2012-06-06.07:44:22.487>
creator = 'sandro.tosi'
dependencies = []
files = ['45086']
hgrepos = []
issue_num = 15013
keywords = ['patch']
message_count = 4.0
messages = ['162395', '162406', '184806', '278613']
nosy_count = 6.0
nosy_names = ['barry', 'terry.reedy', 'r.david.murray', 'sandro.tosi', 'docs@python', 'rooter']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue15013'
versions = ['Python 3.11']

    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.