Typos and issues in the documentation

earnestt1234 / seedir

A Python package for creating, editing, and reading folder tree diagrams

MIT License

122 stars 9 forks source link

Closed earnestt1234 closed 2 years ago

earnestt1234 commented 2 years ago

Wanted to keep track of a few documentation errors which need fixing:

the FakeDir API examples are rendering improperly; three backtick code blocks need to be added
the example for the FakeDir.realize() method is incorrect; the path shown (MyFakeDir/scrooge) is not part of the FakeDir
Typo in the getting started markdown
The example here is confusing since it uses both a reliquary.txt and reliquary.pdf file

earnestt1234 commented 2 years ago

The above issues were fixed in 393f6dc and aa9b55d. Please reopen with more similar problems if needed.