While obviously well-meaning, the suggested branch embodies an idea that is at odds with both the intent of the author and a very useful and pervasive Python convention.
Python classes contain documentation so that within Python, one can ask the the class directly to tell us how it works. While it might be perfectly reasonable to establish a separate readme with a duplicate -- or a variant -- of the class documentation, it is entirely a bad idea to remove the documentation from within the class itself.
Try this:
At a command prompt, with the mainline version of aa_macro in the current directory, type:
python
Then type:
import aa_macro
Then type:
help(aa_macro)
...or...
help(aa_macro.macro)
That is how Python classes self-document. Functions can do this as well. So, barring something really surprising in any responses, this isn't going to be a change I'll accept.
While obviously well-meaning, the suggested branch embodies an idea that is at odds with both the intent of the author and a very useful and pervasive Python convention.
Python classes contain documentation so that within Python, one can ask the the class directly to tell us how it works. While it might be perfectly reasonable to establish a separate readme with a duplicate -- or a variant -- of the class documentation, it is entirely a bad idea to remove the documentation from within the class itself.
Try this:
At a command prompt, with the mainline version of aa_macro in the current directory, type:
Then type:
Then type:
...or...
That is how Python classes self-document. Functions can do this as well. So, barring something really surprising in any responses, this isn't going to be a change I'll accept.