Skip to content

Feature/bec signals#71

Open
wakonig wants to merge 5 commits into
mainfrom
feature/bec_signals
Open

Feature/bec signals#71
wakonig wants to merge 5 commits into
mainfrom
feature/bec_signals

Conversation

@wakonig
Copy link
Copy Markdown
Member

@wakonig wakonig commented May 10, 2026

  • Improve bec signals documentation
  • Add the "What to remember" section where necessary

closes #70

@github-actions
Copy link
Copy Markdown

Remaining TODOs in the docs:

docs/how-to/devices/add-an-epics-motor.md:<!-- TODO: Add video here -->
docs/getting-started/quick-start/04-run-your-first-scan.md:<!-- TODO: link to learn about signals -->
docs/getting-started/quick-start/01-open-bec.md:<!-- TODO: link to different application modes. -->
docs/getting-started/quick-start/01-open-bec.md:<!-- TODO: link to information about deployments. -->
docs/getting-started/next-steps/script-gui-interactions.md:TODO: Revisit as a dedicated, safety-reviewed scripting tutorial.

@wakonig wakonig force-pushed the feature/bec_signals branch 2 times, most recently from 72bb969 to 3c6fdb0 Compare May 10, 2026 09:08
@wakonig wakonig marked this pull request as ready for review May 10, 2026 09:24
@wakonig wakonig requested a review from a team May 10, 2026 09:24
Comment thread docs/how-to/devices/add-a-preview-signal.md
Example:

```python
hinted_h5_entries={"data": "entry/data/data"}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I was stumpling across that while writing the file writer docs. Maybe we can add a proper example on how to use the hinted_h5_entries in custom NeXuS implementations.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

you mean in the file writer how-to?

Comment thread docs/how-to/devices/add-an-async-signal.md
Comment thread docs/how-to/devices/add-a-preview-signal.md Outdated
Comment thread docs/learn/devices/bec-signals.md
@wakonig wakonig force-pushed the feature/bec_signals branch from 3c6fdb0 to 7242e50 Compare May 11, 2026 12:19
@wakonig wakonig self-assigned this May 11, 2026
@wakonig wakonig requested a review from cappel89 May 11, 2026 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to use BECSignals to simplify tasks

2 participants