openedx / code-annotations Goto Github PK

It has been discussed during toggles annotation work that the ability to intermix comments between code annotations doesn't seem to add much value, and instead adds implementation complexity and bugs.

See example test file for this use case:
https://github.com/openedx/code-annotations/blob/master/tests/extensions/python_test_files/multiline_singlelinecomment.pyt

See toggle annotation PR comment about potential issue with linting due to this issue: openedx/edx-platform#27222 (comment).

At this time, users are not given any linting warnings when undefined annotations are used, including misspellings.

Additional Notes:

• An example: someone might use toggle_warnings instead of toggle_warning.
• It has been noted that removing the ability to comment between annotations (see #89) would make this simpler to implement.
• Linting might be implemented here: https://github.com/openedx/edx-lint/blob/7573005f89df7f78142a2af86673206e8b43c4d5/edx_lint/pylint/annotations_check.py#L291

This repository is a depedency of edx-platform and needs to be upgraded to Python 3.11 before
the Readwood release is cut (mid-April).

• Requirements are compiled with Python 3.8
• Tests are run on Python 3.8 and 3.11
• (Optional) Tests are also run with 3.12 and passing or 3.12 issues are ticketed.
• Classifiers in setup.py setup.cfg or pyproject.toml indicate Python 3.11 support
• A new version is release to PyPI
• A PR is merged to edx-platform to use the new version

The license in the repo changed to Apache 2.0, but the documentation (including in the README and on PyPI) still states that it's AGPL. This is a deterrent to wider use, since that's the first thing people see on PyPI.