antoinecarme / pyaf

PyAF is an Open Source Python library for Automatic Time Series Forecasting built on top of popular pydata modules.
BSD 3-Clause "New" or "Revised" License
457 stars 73 forks source link

Grammatical and punctuation fixes to the README file #173

Closed shaido987 closed 3 years ago

shaido987 commented 3 years ago

Some minor grammatical and punctuation fixes to the readme for easier reading flow. I also noted that the content under the "Development" and "Help and Support" sections are very similar, maybe they could be merged.

antoinecarme commented 3 years ago

@shaido987

Thanks a lot for using PyAF and for this pull request. PyAF documentation is a work in progress. Some issues are already available in the category class:Doc

https://github.com/antoinecarme/pyaf/issues?q=is%3Aissue+is%3Aopen+label%3Aclass%3ADoc

You may also probably help with some of these issues.

The README file is an evolving document describing the current state of PyAF and will change on every major release (one is coming in the next few days ;). This document is mainly intended to be indexed by search engines.

Could you please create an issue describing the content of this PR and summarizing the major changes to the README file?

Antoine

shaido987 commented 3 years ago

@antoinecarme

I created a new issue for this PR that explains the main changes here: #174 It's no major change, just some smaller things to improve the readability. :)