Skip to content

Improve documentation of property sources #138

@banchan86

Description

@banchan86
Contributor

The documentation for property sources could be improved by:

  • Providing some application examples/recipes.
  • Addressing the common misconception that they automatically update the property in the operator which they originate from.
  • Using subjects to avoid branching of property sources for proper initialization of file writers/readers.
  • Feeding the original image back into the property source for property editors.

Some old discussions to pull information from:
https://groups.google.com/g/bonsai-users/c/lEj2W_5qgfQ/m/boonkFcyAQAJ
https://groups.google.com/g/bonsai-users/c/Xk7AJajlIyQ/m/yG0CgnfUCAAJ
https://groups.google.com/g/bonsai-users/c/ElLT49caoao/m/yD7aKJaHAgAJ

As they are part of the context menu for the editor, it might be worth including them as part of the Language section of the Bonsai Manual. Could be part of the property mapping article, or maybe a separate article.

Activity

self-assigned this
on Apr 8, 2025
edmundchong

edmundchong commented on Jun 17, 2025

@edmundchong

related to this: to add details about property initialization (which ones are dynamic vs at run-time vs at compile)?
https://github.com/orgs/bonsai-rx/discussions/2346

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @edmundchong@banchan86

      Issue actions

        Improve documentation of property sources · Issue #138 · bonsai-rx/docs