Skip to content

gh-67512: IMAP4.append() - documented in Doc/library/imaplib.rst #113501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

Rajendra1308
Copy link

@Rajendra1308 Rajendra1308 commented Dec 26, 2023

The IMAP4.append() method was not properly documented which led to various issues in terms of proper usage of the functions. This change solved the #67512


📚 Documentation preview 📚: https://cpython-previews--113501.org.readthedocs.build/

@Rajendra1308 Rajendra1308 requested review from a team as code owners December 26, 2023 20:16
@ghost
Copy link

ghost commented Dec 26, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app
Copy link

bedevere-app bot commented Dec 26, 2023

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@hugovk
Copy link
Member

hugovk commented Dec 26, 2023

Hmm, one of the CI failures is new to me:

# Fetch enough history to find a common ancestor commit (aka merge-base):
  git fetch origin +4a5f4e5[3](https://github.com/python/cpython/actions/runs/7332379271/job/19966447077?pr=113501#step:3:3)31da7b9f0d52237da7772736a260e327:remotes/origin/gh-#67512-mention-that-flags-arg-to-imaplib's-append-should-be-a-string --depth=$(( 1 + 1 )) \
    --no-tags --prune --no-recurse-submodules
  
  # This should get the oldest commit in the local fetched history (which may not be the commit the PR branched from):
  COMMON_ANCESTOR=$( git rev-list --first-parent --max-parents=0 --max-count=1 origin/gh-#67512-mention-that-flags-arg-to-imaplib's-append-should-be-a-string )
  DATE=$( git log --date=iso8601 --format=%cd "${COMMON_ANCESTOR}" )
  
  # Get all commits since that commit date from the base branch (eg: master or main):
  git fetch origin +[4](https://github.com/python/cpython/actions/runs/7332379271/job/19966447077?pr=113501#step:3:4)e67644d367673bbacc40a0d8efb777410437b93:remotes/origin/main --shallow-since="${DATE}" \
    --no-tags --prune --no-recurse-submodules
  shell: /usr/bin/bash -e {0}
  env:
    branch_base: origin/main
    branch_pr: origin/gh-#67[5](https://github.com/python/cpython/actions/runs/7332379271/job/19966447077?pr=113501#step:3:5)12-mention-that-flags-arg-to-imaplib's-append-should-be-a-string
    refspec_base: +4e[6](https://github.com/python/cpython/actions/runs/7332379271/job/19966447077?pr=113501#step:3:6)7644d367673bbacc40a0d8efb777410437b93:remotes/origin/main
    refspec_pr: +4a5f4e5331da7b9f0d52237da7772736a260e327:remotes/origin/gh-#67512-mention-that-flags-arg-to-imaplib's-append-should-be-a-string
/home/runner/work/_temp/754e2a0b-c0b8-43bd-8c10-70085ea407c3.sh: line 6: syntax error near unexpected token `)'

https://github.com/python/cpython/actions/runs/7332379271/job/19966447077?pr=113501

I think this might be caused by the # or ' in the branch name.

Please could you make a new branch with just letters/numbers/hyphens/underscores, and make a new PR from that?

Something like:

git checkout -b imaplib-append

Also, please don't change .gitignore or add PCbuild/UpgradeLog.htm.

@hugovk hugovk added the pending The issue will be closed if no feedback is provided label Dec 26, 2023
@hugovk
Copy link
Member

hugovk commented Dec 27, 2023

Closing in favour of new PR: #113506

@hugovk hugovk closed this Dec 27, 2023
@AA-Turner AA-Turner removed the pending The issue will be closed if no feedback is provided label Apr 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants