search

davydany / sultan

Sultan: Command and Rule over your Shell
https://sultan.readthedocs.io/en/latest/
MIT License
680 stars 35 forks source link

Pydoc #11

Closed j3r1ch0 closed 8 years ago

j3r1ch0 commented 8 years ago

I think the "pydoc" should be filled out with classes and methods in order to provide better documentation for the project. I tried "pydoc sultan" on my local machine but the lack of information there forced me to search out this github page to figure out exactly how to use it in my scripts.

davydany commented 8 years ago

that's a good idea. I'll do that!

j3r1ch0 commented 8 years ago

Awesome! Thanks!

davydany commented 8 years ago

@j3r1ch0 I added documentation to the classes that are publicly usable, and added a read the docs: http://sultan.readthedocs.io/en/latest/

davydany commented 8 years ago

@j3r1ch0 Let me know if that's what you're looking for.

j3r1ch0 commented 8 years ago

@davydany The way you did it works fine. Thanks for getting around to it quickly! Have a good one.

davydany commented 8 years ago

@j3r1ch0 Great! Thanks! Please share Sultan with other devs you know :smile: