Skip to content

add enum description son top of declaration, wrap comments #844

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.

Sign up for GitHub

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

Merged
iscai-msft merged 5 commits into from
Dec 15, 2020
Merged

add enum description son top of declaration, wrap comments #844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b912acf
add descriptions on top of enums
iscai-msft Dec 8, 2020
deb5629
revert erroneous deletion
iscai-msft Dec 8, 2020
3b47f03
update changelog
iscai-msft Dec 8, 2020
cd6723f
Merge branch 'autorestv3' of https://github.com/Azure/autorest.python…
iscai-msft Dec 9, 2020
811d366
regenerate with new enum description
iscai-msft Dec 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Change Log

### 2020-xx-xx - 5.5.1
Autorest core version: 3.0.6318

Modelerfour version: 4.15.421

**Bug Fixes**

- Wrap individual enum descriptions #844

### 2020-11-12 - 5.5.0
Autorest core version: 3.0.6318

Expand Down
5 changes: 4 additions & 1 deletion autorest/codegen/templates/enum.py.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,8 @@ class {{ enum.name }}(with_metaclass(_CaseInsensitiveEnumMeta, {{ enum.enum_type
{% endif %}

{% for value in enum.values %}
{{ value.name }} = {{ enum.enum_type.get_declaration(value.value) }}{{ " #: " + value.description if value.description else "" }}
{% if value.description %}
#: {{ value.description | wordwrap(width=95, break_long_words=False, wrapstring='\n #: ') }}
{% endif %}
{{ value.name }} = {{ enum.enum_type.get_declaration(value.value) }}
{% endfor %}
12 changes: 8 additions & 4 deletions ...pi/Expected/AcceptanceTests/Multiapi/multiapi/v3/models/_multiapi_service_client_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ class ContentType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Content type for upload
"""

APPLICATION_PDF = "application/pdf" #: Content Type 'application/pdf'.
IMAGE_JPEG = "image/jpeg" #: Content Type 'image/jpeg'.
IMAGE_PNG = "image/png" #: Content Type 'image/png'.
IMAGE_TIFF = "image/tiff" #: Content Type 'image/tiff'.
#: Content Type 'application/pdf'.
APPLICATION_PDF = "application/pdf"
#: Content Type 'image/jpeg'.
IMAGE_JPEG = "image/jpeg"
#: Content Type 'image/png'.
IMAGE_PNG = "image/png"
#: Content Type 'image/tiff'.
IMAGE_TIFF = "image/tiff"
12 changes: 8 additions & 4 deletions ...DefaultPolicy/multiapicredentialdefaultpolicy/v3/models/_multiapi_service_client_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ class ContentType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Content type for upload
"""

APPLICATION_PDF = "application/pdf" #: Content Type 'application/pdf'.
IMAGE_JPEG = "image/jpeg" #: Content Type 'image/jpeg'.
IMAGE_PNG = "image/png" #: Content Type 'image/png'.
IMAGE_TIFF = "image/tiff" #: Content Type 'image/tiff'.
#: Content Type 'application/pdf'.
APPLICATION_PDF = "application/pdf"
#: Content Type 'image/jpeg'.
IMAGE_JPEG = "image/jpeg"
#: Content Type 'image/png'.
IMAGE_PNG = "image/png"
#: Content Type 'image/tiff'.
IMAGE_TIFF = "image/tiff"
12 changes: 8 additions & 4 deletions ...anceTests/MultiapiDataPlane/multiapidataplane/v3/models/_multiapi_service_client_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ class ContentType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Content type for upload
"""

APPLICATION_PDF = "application/pdf" #: Content Type 'application/pdf'.
IMAGE_JPEG = "image/jpeg" #: Content Type 'image/jpeg'.
IMAGE_PNG = "image/png" #: Content Type 'image/png'.
IMAGE_TIFF = "image/tiff" #: Content Type 'image/tiff'.
#: Content Type 'application/pdf'.
APPLICATION_PDF = "application/pdf"
#: Content Type 'image/jpeg'.
IMAGE_JPEG = "image/jpeg"
#: Content Type 'image/png'.
IMAGE_PNG = "image/png"
#: Content Type 'image/tiff'.
IMAGE_TIFF = "image/tiff"
12 changes: 8 additions & 4 deletions ...ceptanceTests/MultiapiNoAsync/multiapinoasync/v3/models/_multiapi_service_client_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ class ContentType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Content type for upload
"""

APPLICATION_PDF = "application/pdf" #: Content Type 'application/pdf'.
IMAGE_JPEG = "image/jpeg" #: Content Type 'image/jpeg'.
IMAGE_PNG = "image/png" #: Content Type 'image/png'.
IMAGE_TIFF = "image/tiff" #: Content Type 'image/tiff'.
#: Content Type 'application/pdf'.
APPLICATION_PDF = "application/pdf"
#: Content Type 'image/jpeg'.
IMAGE_JPEG = "image/jpeg"
#: Content Type 'image/png'.
IMAGE_PNG = "image/png"
#: Content Type 'image/tiff'.
IMAGE_TIFF = "image/tiff"
12 changes: 8 additions & 4 deletions ...WithSubmodule/multiapiwithsubmodule/submodule/v3/models/_multiapi_service_client_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ class ContentType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Content type for upload
"""

APPLICATION_PDF = "application/pdf" #: Content Type 'application/pdf'.
IMAGE_JPEG = "image/jpeg" #: Content Type 'image/jpeg'.
IMAGE_PNG = "image/png" #: Content Type 'image/png'.
IMAGE_TIFF = "image/tiff" #: Content Type 'image/tiff'.
#: Content Type 'application/pdf'.
APPLICATION_PDF = "application/pdf"
#: Content Type 'image/jpeg'.
IMAGE_JPEG = "image/jpeg"
#: Content Type 'image/png'.
IMAGE_PNG = "image/png"
#: Content Type 'image/tiff'.
IMAGE_TIFF = "image/tiff"
6 changes: 4 additions & 2 deletions ...d/AcceptanceTests/BodyComplex/bodycomplex/models/_auto_rest_complex_test_service_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,10 @@ class GoblinSharkColor(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
PINK = "pink"
GRAY = "gray"
BROWN = "brown"
UPPER_RED = "RED" #: Uppercase RED.
LOWER_RED = "red" #: Lowercase RED.
#: Uppercase RED.
UPPER_RED = "RED"
#: Lowercase RED.
LOWER_RED = "red"

class MyKind(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):

Expand Down
10 changes: 7 additions & 3 deletions ...ted/AcceptanceTests/ExtensibleEnums/extensibleenumsswagger/models/_pet_store_inc_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ class DaysOfWeekExtensibleEnum(with_metaclass(_CaseInsensitiveEnumMeta, str, Enu

class IntEnum(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):

ONE = "1" #: one.
TWO = "2" #: two.
THREE = "3" #: three.
#: This is a really long comment to see what wrapping looks like. This comment is really long and
#: it should wrap for readability. Please wrap. This should wrap.
ONE = "1"
#: two.
TWO = "2"
#: three.
THREE = "3"
12 changes: 8 additions & 4 deletions ...anilla/Expected/AcceptanceTests/MediaTypes/mediatypes/models/_media_types_client_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ class ContentType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Content type for upload
"""

APPLICATION_PDF = "application/pdf" #: Content Type 'application/pdf'.
IMAGE_JPEG = "image/jpeg" #: Content Type 'image/jpeg'.
IMAGE_PNG = "image/png" #: Content Type 'image/png'.
IMAGE_TIFF = "image/tiff" #: Content Type 'image/tiff'.
#: Content Type 'application/pdf'.
APPLICATION_PDF = "application/pdf"
#: Content Type 'image/jpeg'.
IMAGE_JPEG = "image/jpeg"
#: Content Type 'image/png'.
IMAGE_PNG = "image/png"
#: Content Type 'image/tiff'.
IMAGE_TIFF = "image/tiff"