facebook / facebook/prophet

Where's the actual API documentation?

Open
#2,398 3 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
20.4k
Forks
4.6k
Avg merge
19h 52m
Merged PRs (30d)
1

Description

Hi. I have been looking for the documentation for the usage of this library in Python.

Unfortunately, all I could come across was this marketing pamphlet:
https://facebook.github.io/prophet/docs/quick_start.html

This is not documentation. These are examples of functionality.

This is documentation for a library:
https://prophet.readthedocs.io/en/latest/api.html#module-prophet

Where would I find the equivelant for this library?

Contributor guide

Open the contributing guide

Research direction

Start by comparing the linked quick-start page with the linked ReadTheDocs API reference, then inspect the repository's existing Python documentation entry points. Determine which public Python API lacks reference coverage; done means users can find an equivalent API reference for the library's Python usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.