Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code is not documented #9

Open
robertmclaws opened this issue Dec 25, 2016 · 1 comment
Open

Code is not documented #9

robertmclaws opened this issue Dec 25, 2016 · 1 comment

Comments

@robertmclaws
Copy link
Contributor

There is a certain level of irony in a codebase that is designed to turn XML documentation comments into Markdown not having any XML documentation comments that could themselves be turned into Markdown. 😄

@Pxtl
Copy link
Owner

Pxtl commented Dec 28, 2016

Hah, yeah. Part of the reason is that it was really just a rather oddly-factored snippet I grabbed off of gist and started cleaning up and bolting on features that I needed for something else I was working on. Funny how it's the project you do as a quick side-thing for your own use that gets all the users, y'know?

Also, it's not really properly factored as a library, where the XML comments would be useful. I can't imagine anybody using this code as a lib without a pretty hefty re-write.

Either way, good point to have this on the to-do list.

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

No branches or pull requests

2 participants