anvaka / anvaka/ngraph.graph

Documentation Error: `removeLink` using two arguments

Open
#43 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
580
Forks
72
PR merge metrics
No merged PRs in 30d

Description

The `removeLink` method has the following passage in the documentation:

```
If you pass two arguments, the function assumes they represent from/to node ids
```

I assume this means something like `removeLink(fromID,toID)`? If so, the method's typing doesn't support this signature.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the `removeLink` documentation passage and comparing it with the method's JavaScript typing and supported signatures. Confirm whether two node IDs are intended to be accepted, then update the documentation or typing so they agree and verify the resulting API description.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.