Skip to content

Conversation

@regisb
Copy link
Contributor

@regisb regisb commented Aug 27, 2020

Description:

Multiline annotations were previously supported only for multi-line comments. In Python: """..."""

This introduces multiline annotations for comments prefixed by single-line comment signs. In Python:

    # .. pii: a multiline annotation
    #   that spans multiple lines.

This makes it possible to wrap long comment lines more naturally, in particular in Python.

JIRA: https://openedx.atlassian.net/wiki/spaces/COMM/pages/1596358943

Dependencies: This feature can be tested on this PR: https://github.com/edx/edx-platform/pull/24815

Reviewers:

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPi after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

@openedx-webhooks
Copy link

Thanks for the pull request, @regisb! I've created BLENDED-564 to keep track of it in Jira. More details are on the BD-21 project page.

When this pull request is ready, tag your edX technical lead.

@openedx-webhooks openedx-webhooks added blended PR is managed through 2U's blended developmnt program needs triage labels Aug 27, 2020
@regisb regisb force-pushed the regisb/multiline-with-singlelinecomment branch from fd204c4 to d46aeb9 Compare August 27, 2020 14:54
@regisb regisb force-pushed the regisb/multiline-with-singlelinecomment branch 3 times, most recently from 58546d9 to 8539c26 Compare August 27, 2020 15:10
Copy link
Contributor

@robrap robrap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I don't think it is far off.

@regisb regisb force-pushed the regisb/multiline-with-singlelinecomment branch 6 times, most recently from a26b3cf to b090d6a Compare August 31, 2020 13:19
@regisb regisb force-pushed the regisb/multiline-with-singlelinecomment branch 2 times, most recently from 021a255 to a3e83d9 Compare September 1, 2020 09:22
Copy link
Contributor

@robrap robrap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. Thanks. Let me know when you consider this squashed (whatever you think) and I can merge.
UPDATE: ...once you fix the quality failure. I looked quickly, and it may just make sense to disable the rule if it is just accessing for a test.

Multiline annotations were previously supported only for multi-line
comments. In Python: """..."""

This introduces multiline annotations for comments prefixed by
single-line comment signs. In Python:

    # .. pii: a multiline annotation
    #   that spans multiple lines.

This makes it possible to wrap long comment lines more naturally, in
particular in Python.
@regisb regisb force-pushed the regisb/multiline-with-singlelinecomment branch from a3e83d9 to 097db99 Compare September 2, 2020 07:24
@regisb
Copy link
Contributor Author

regisb commented Sep 2, 2020

@robrap: This is ready to merge :)

@robrap robrap merged commit f61565d into openedx:master Sep 2, 2020
@regisb regisb deleted the regisb/multiline-with-singlelinecomment branch January 22, 2021 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blended PR is managed through 2U's blended developmnt program merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants