Likely invalid example in the docs

Open
  • Is something wrong?
#323 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Open the bionet.html document at the linked URL and inspect the input example near the bottom. Verify the duplicated replay_1 key and update the example so its input keys are distinct and valid. Done means the rendered documentation no longer shows the same key twice.

Written by the indexing model from the issue text.

Description

At the bottom of this document the key replay_1 is given twice. I'm assuming this is not going to lead to the intended result:

https://alleninstitute.github.io/bmtk/bionet.html

{
  "inputs": {
    "replay_1": {
      "input_type": "replay_spikes",
      "module": "replay",
      ...
    },
    "replay_1": {
      "input_type": "replay_spikes",
      "module": "replay",
      ...
    }
  }
}
Dominant language
Python
Stars
339
Forks
103
Avg merge
2h 7m
Merged PRs (30d)
14

Getting set up

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.

More from AllenInstitute/bmtk

All issues in AllenInstitute/bmtk

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.