Instagram / Instagram/LibCST

Documentation example doesn't work out of the box: metadata provider

Open
#449 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
Python
Stars
1.9k
Forks
229
PR merge metrics
No merged PRs in 30d

Description

The example of getting code positions using ``PositionProvider`` no longer works, as the API has changed from ``libcst.PositionProvider`` to ``libcst.metadata.PositionProvider``.

Example at https://github.com/Instagram/LibCST/blob/master/docs/source/metadata.rst#metadata-apis.

Fixing this is obviously trivial, but was wondering if you'd considered setting up doctests to prevent this kind of mistake slipping in?

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.