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

Improve documentation #1

Open
dgtlmoon opened this issue Mar 23, 2018 · 2 comments
Open

Improve documentation #1

dgtlmoon opened this issue Mar 23, 2018 · 2 comments

Comments

@dgtlmoon
Copy link

Hello and thank you for the project, but it would really help people to contribute to it if the documentation was a little better :)

The USAGE example could be a little more clearer I think.

dgtlmoon pushed a commit to dgtlmoon/sylk_parser that referenced this issue Mar 23, 2018
@dgtlmoon dgtlmoon changed the title Update bad documentation Improve documentation Mar 23, 2018
tonthon added a commit that referenced this issue Mar 28, 2018
Re #1 Improve documentation.
@dgtlmoon
Copy link
Author

Thanks! yeah, it's a small detail, but it helps alot :)

@tonthon
Copy link
Member

tonthon commented Mar 28, 2018

Since we're missing some docs.
I'll say it here
There are some hardcoded header tests regarding the date format that replace the datebase
https://github.com/majerteam/sylk_parser/blob/master/sylk_parser/sylk.py#L165

So depending the files you want to parse, you may encounter some date translation problems

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