More in-depth docs/API - Githubissues

jkob commented 4 years ago

Hi,

Been toying around with this project for a bit and it's been great. But I'm having trouble figuring out what goes where. For example:

Where do I define the color to use (the pyfiglet class or the Figlet class?)

Very likely that I'm missing something obvious. But for me, the short "Quickstart" guide on how to use the package (by importing into code) is not very clear. Maybe this is something that can be accomplished along with #74?

pwaller commented 3 years ago

Thanks for raising this. I agree it's not clear to a newcomer. Improvements welcomed. I don't have time to address the general complaint very well myself but I will review changes which improve the situation. The smaller the changes the better.

At the moment I'd recommend reading the source code if you want to know how it works and the API and have a need which isn't immediately addressed by just poking around. (e.g. search for "color" and look for relevant-looking code).

Addressing your colour question in particular:

https://github.com/pwaller/pyfiglet/blob/81f30a56c04c7df1bd2109541babf2d4fb7b9bdd/pyfiglet/__init__.py#L69-L78

pwaller commented 1 year ago

Another request from #105, merging into this issue:

Are there any docs containing list of colors, fonts, and functions/classes as well as their args(that the user is supposed to use)?

pwaller / pyfiglet

More in-depth docs/API #78