feat: enhance SciLog messaging documentation with table creation example - #87
Merged
Conversation
|
Remaining TODOs in the docs: |
1 task
wakonig
force-pushed
the
feature/scilog_table
branch
from
September 8, 2026 10:53
93a535b to
a1bb183
Compare
wyzula-jan
approved these changes
Sep 8, 2026
There was a problem hiding this comment.
🟢 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: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.