NetLogo / NetLogo/Matrix-Extension

Provide more extensive documentation on `real-eigenvalues` and `imaginary-eigenvalues`

Open
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
8
Forks
6
PR merge metrics
No merged PRs in 30d

Description

It took @qiemem and I a few minutes to figure out how these primitives work together (although the way they worked together was close to one of our initial guesses).

observer> show matrix:imaginary-eigenvalues matrix:from-row-list [[3 -2] [4 -1]]
observer: [2 -2]
observer> show matrix:real-eigenvalues matrix:from-row-list [[3 -2] [4 -1]]
observer: [1 1]

Adding some short narrative documentation about using these primitives together would be helpful for users and maintainers.

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 finding the documentation for the real-eigenvalues and imaginary-eigenvalues primitives, then review the matrix:from-row-list examples shown in the issue. Done means the documentation includes a short narrative explaining how the two primitives work together and demonstrates their use with a matrix example.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.