search

izar / pytm

A Pythonic framework for threat modeling
Other
891 stars 168 forks source link

Fixed the alignment of the element description #140

Closed raphaelahrens closed 3 years ago

raphaelahrens commented 3 years ago

If an element has a long doc string with newlines in it the description was difficult to read. For example:

  credentialsLife          Credentials lifetime, describing if and how
credentials can be revoked. One of:
* NONE - not applicable
* UNKNOWN - unknown lifetime
* HARDCODED - cannot be invalidated at all, default: Lifetime.NONE

With this commit the description is aligned with the first line of the description.

  credentialsLife          Credentials lifetime, describing if and how
                           credentials can be revoked. One of:
                           * NONE - not applicable
                           * UNKNOWN - unknown lifetime
                           * HARDCODED - cannot be invalidated at all
                           default: Lifetime.NONE

As a side effect the default and required flags are on a separated line. I think this makes them easier to spot. But this could be changed with extra code.

ghost commented 3 years ago

Congratulations :tada:. DeepCode analyzed your code in 10362.929 seconds and we found no issues. Enjoy a moment of no bugs :sunny:.

👉 View analysis in DeepCode’s Dashboard | Configure the bot

izar commented 3 years ago

Thanks!

nineinchnick commented 3 years ago

@izar you've closed this without merging it.

izar commented 3 years ago

Funky, I merged then commented as I always do.