NetLogo / NetLogo/NetLogo

Link to implementation of primitives from dictionary

Open
#1,673 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc
Dominant language
Scala
Stars
1.2k
Forks
272
PR merge metrics
No merged PRs in 30d

Description

Hi guys,

We have a few teachers asking to see the implementation of primitives. I don't know how much it would really help them to see the Scala implementation, but on the other hand, I don't want to stand in their way. I see this as similar to letting students see the NetLogo source code even though they may not totally get everything that is going on.

However, there is no "code" tab for the Scala implementation. Would it make sense to put a link to the implementation of the primitive in the dictionary for all primitive? I know that many primitives rely on helper functions etc. so you'd need to look around to truly understand what it does, but the link could just take them to the right class and line here on Github where the Reporter or Command class is declared.

Is this stupid? Does the potential downside of confusing people who do not want to see it outweigh the benefit of showing how NetLogo works under the hood? Thoughts?

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 dictionary entries for primitives and the Scala Reporter and Command declarations mentioned in the issue. Determine how implementation links could be added for all primitives without obscuring the dictionary, then verify that each applicable entry points to the relevant GitHub source location.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.