Suggestion - new documentation for syntax-related issues
Closed this issue · 1 comments
The code is lovely and self-documenting.
However, there are some syntax choices that may raise questions -- e.g. the difference between pack_propagate(0) and pack, the use of ntpath instead of os.path, and others.
As this is a by-example guide, I suggest the creation of a separate Markdown readme file to briefly describe why some of the code choices were made. It should not be a full-blown documentation, just a simple summary of those parts that may potentially confuse, why it was coded that way, and if necessary, some further references for more extended reading. I am happy to help out.
Hi xonoma
Thanks for the suggestion.
Since it's me who wrote the code and made all of the decisions, it's hard to determine what people may find confusing or questionable. If you could provide me with a list of what you would suggest I clarify that would be great.