Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a config system quirks notebook #1224

Merged
merged 1 commit into from
Feb 9, 2017
Merged

Add a config system quirks notebook #1224

merged 1 commit into from
Feb 9, 2017

Conversation

tbekolay
Copy link
Member

@tbekolay tbekolay commented Dec 5, 2016

Motivation and context:
#615 noted an unexpected way in which the config system works: config context matters, network membership does not. This PR attempts to explain this through a notebook, which is rendered in the documentation.

How has this been tested?
I built the documentation locally and ensured that it rendered properly.

How long should this take to review?

  • Average (neither quick nor lengthy)

Types of changes:

  • Non-code change (touches things like tests, documentation, build scripts)

Checklist:

  • I have read the CONTRIBUTING.rst document.
  • I have updated the documentation accordingly.
  • I have included a changelog entry.
  • [NA] I have added tests to cover my changes.
  • All new and existing tests passed.

@Seanny123
Copy link
Contributor

LGTM.

@jgosmann jgosmann self-requested a review December 14, 2016 19:28
Copy link
Collaborator

@jgosmann jgosmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🍰

It's confusing that config context, not network membership,
determines the defaults used by the config system. This new notebook
explains that this happens, and gives some insight into why.

This commit also adds a quirks folder to the set of examples, which
could be a good place to put other potentially confusing aspects
of Nengo.

Addresses #615.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants