Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Improve coherence in function naming and documentation #1151
Comments
|
Thanks for the examples, and I think there is definitely room for improvement in the documentation within the code. Some of the incoherence is due to trying to simultaneously follow R standards while also making the code as similar as possible to the Python version. That's the reason |
|
Thank you for your reply. Of all of the above, I would think that documentation is the most pressing issue. There is a lot of info on the online manual which is missing in the R/python doc, as far as I can tell. |
|
Docstrings were fixed in the latest version. |
While Prophet is a very powerful library which produces excellent forecasting, its function structure and documentation quality is not at the same level.
For example, functions do not seem to follow a coherent naming scheme.
For instance, in R: some functions use
_as separator (add_country_holidays), some.(fit.prophet). Some plotting functions start withplot(plot_forecast_component), some do not (prophet_plot_components).Personally I would suggest that this should be addressed sooner rather than later, when more people will use the library and change will be harder.
Additionally, always in R, the documentation is somewhat lacking:
cross_validation)Some lack of coherence can be found in arguments type as well:
add_coutry_holidaysaccepts an input like"US", while usingprophetdirectly does not (at least according to the doc).Hopefully this could be improved in future revisions!