-
Notifications
You must be signed in to change notification settings - Fork 10
[BD-21] Multiline annotations with single-line comment prefix ("#") #48
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
[BD-21] Multiline annotations with single-line comment prefix ("#") #48
Conversation
|
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. |
fd204c4 to
d46aeb9
Compare
58546d9 to
8539c26
Compare
robrap
left a comment
There was a problem hiding this 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.
a26b3cf to
b090d6a
Compare
021a255 to
a3e83d9
Compare
There was a problem hiding this 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.
a3e83d9 to
097db99
Compare
|
@robrap: This is ready to merge :) |
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:
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:
Documentation updated (not only docstrings)Post merge:
finished.