triniwiz / triniwiz/nativescript-plugins

[Couchbase] Documentation is outdated

Open
#215 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
87
Forks
57
Avg merge
1h 36m
Merged PRs (30d)
4

Description

It seems the docs are still referring to v1.4 API and completely irrelevant for v2.0.

Edit: Well, I see that common.ts has been removed, which makes extends Common meaningless in the types. I don't know if the file was removed accidentally or intentionally, but that’s why none of the methods mentioned in the documentation are accessible.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation that still references the v1.4 API and compare it with the v2.0 types. Inspect common.ts and the types that extend Common to determine whether its removal explains the inaccessible methods. Done means the documentation matches the v2.0 API and the Common-related discrepancy is clarified.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.