facebook / facebook/watchman

Pywatchman docs

Open
#988 2 comments 0 reactions 0 assignees View on GitHub
python
Dominant language
C++
Stars
13.7k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

### Are there any docs for pywatchman specifically?

The PyPi page for pywatchman directs you to this repo, which has a link to some generic watchman docs. But I can't find anything about pywatchman itself. I appreciate the source-code is available for one to inspect, but figuring it out whilst you're still getting to grips with watchman itself can be tricky.

Even just a few examples demonstrating some basics would be incredibly helpful. Something similar to the page provided for the NodeJS docs. I would be very happy to contribute if such a notion was acceptable in principle - although I would put myself in the category I described above, so there would definitely be others better qualified to do so.

(I apologise if I am missing some obvious part of the docs. I have tried to look carefully through them).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.