Skip to content
This repository was archived by the owner on Oct 23, 2019. It is now read-only.

Documentation for BaseFormatter methods #16

Closed
expectocode opened this issue Feb 26, 2018 · 4 comments
Closed

Documentation for BaseFormatter methods #16

expectocode opened this issue Feb 26, 2018 · 4 comments

Comments

@expectocode
Copy link
Owner

It's not very friendly to require Formatter writers to read the BaseFormatter methods. We should generate some docs, even if only to display name and docstring.

@expectocode
Copy link
Owner Author

Something that people can use to list methods and their descriptions is python3 -m pydoc formatters/baseformatter.py. It works decently for now.

@Lonami
Copy link
Collaborator

Lonami commented Feb 27, 2018

Oh, pydoc is cool, but sure something like readthedocs would be even more friendly.

It's not very friendly to require Formatter writers to read the BaseFormatter methods.

That's silly, though. If you're going to develop for a library you definitely should know at least the method definitions, and since this isn't aimed at end users (rather, other programmers), it's not that much of an issue. Once a few formatters are ready anyway I doubt anyone has the need for more and if they do any technical user wouldn't mind reading the definitions or starting from another formatter that's already implemented if they were to write a new one.

@expectocode
Copy link
Owner Author

True. I think pydoc and personal conversations should suffice for our purposes.

@Lonami
Copy link
Collaborator

Lonami commented Feb 27, 2018

Closing issues without writing any code 101.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants