Skip to content

Tweaks to the explanation of the catalog - #47

Merged
GamelinAl merged 3 commits into
docs/intro-structure-configurationfrom
docs/catalog
Sep 25, 2026
Merged

GamelinAl merged 3 commits into
docs/intro-structure-configurationfrom
docs/catalog

Conversation

@TeresiaOlsson

@TeresiaOlsson TeresiaOlsson commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

Work in progress on updates to the catalog page.

Done so far:

  • Highlighted the recommendation to use a dynamic catalog as a tip.
  • Made the list of static catalog classes in tango-pyaml into a list

@GamelinAl I have a question about the dynamic catalog: is the page trying to say that it currently only exists for pyaml-cs-oa? So for tango-pyaml a static catalog is currently the only option?

I also think it is confusing to have both:

controls:
  - class: pyaml_cs_oa.controlsystem.OphydAsyncControlSystem
    name: live
    catalog:
      class: pyaml_cs_oa.dynamic_catalog.DynamicCatalog
      backend: tango

and

controls:
  - class: pyaml_cs_oa.controlsystem.OphydAsyncControlSystem
    name: live
    backend: tango

So I'm wondering if we should skip the first option? Alternatively, swap so we present the second option first (since that would be the recommended way) and then say it means the same as the first option as a bridge to later show how the configuration looks for a static catalog.

@GamelinAl

Copy link
Copy Markdown
Member

I think the page was out of date or something. From what I see there is a dynamic catalog for tango-pyaml.

I agree that the present text is confusing, it can be improved. We can skip the 1st option.

@TeresiaOlsson

Copy link
Copy Markdown
Member Author

I think the page was out of date or something. From what I see there is a dynamic catalog for tango-pyaml.

I agree that the present text is confusing, it can be improved. We can skip the 1st option.

I think so too. Only difference I noticed between the two last time I looked at is how the catalog is implemented.

I will add a suggestion for the update to this PR.

@TeresiaOlsson
TeresiaOlsson marked this pull request as ready for review September 24, 2026 16:37
@GamelinAl
GamelinAl merged commit 352949f into docs/intro-structure-configuration Sep 25, 2026
2 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.

2 participants