Skip to content

feat: enhance SciLog messaging documentation with table creation example - #87

Merged
wakonig merged 1 commit into
mainfrom
feature/scilog_table
Sep 8, 2026
Merged

feat: enhance SciLog messaging documentation with table creation example#87
wakonig merged 1 commit into
mainfrom
feature/scilog_table

Conversation

@wakonig

@wakonig wakonig commented Sep 8, 2026

Copy link
Copy Markdown
Member

No description provided.

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown

Remaining TODOs in the docs:

docs/how-to/devices/add-an-epics-motor.md:<!-- TODO: Add video here -->
docs/how-to/general/send-messages-to-signal.md:<!-- TODO: Uncomment once we have a better support for stickers -->
docs/getting-started/next-steps/script-gui-interactions.md:TODO: Revisit as a dedicated, safety-reviewed scripting tutorial.
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. -->

@wakonig
wakonig force-pushed the feature/scilog_table branch from 93a535b to a1bb183 Compare September 8, 2026 10:53
@wyzula-jan
wyzula-jan requested review from wyzula-jan and a lite review from Copilot September 8, 2026 14:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

The changes are documentation-only and low risk, with just a minor clarity tweak suggested.

Pull request overview

This PR enhances the SciLog messaging “how-to” documentation by adding guidance and an example for creating and populating custom tables within SciLog messages from the BEC IPython client.

Changes:

  • Expands the overview to explicitly include sending tables to SciLog.
  • Adds a new “Build custom tables” section with an end-to-end code example and usage notes.
  • Updates the closing summary text to include the new table-building capability.
File summaries
File Description
docs/how-to/general/send-messages-to-scilog.md Adds a custom table creation example and updates surrounding messaging guidance to reflect table support.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

## 5. Use SciLog wrapper helpers
## 5. Build custom tables

Pass a list of headings to `msg.add_table(columns=[...])` to create all columns in one call, then loop over your data to add rows. For example, calculate quadratic values in a simple loop:
@wakonig
wakonig merged commit 924aada into main Sep 8, 2026
11 checks passed
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.

3 participants