Skip to content

#3075 fix system macros documentation #3087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jul 23, 2024
Merged

#3075 fix system macros documentation #3087

merged 2 commits into from
Jul 23, 2024

Conversation

@shroffk
Copy link
Member

@shroffk shroffk commented Jul 23, 2024 •
edited
Loading

small but rather important correction in the documentation

@shroffk shroffk requested a review from georgweiss July 23, 2024 15:08
@kasemir
Copy link
Collaborator

kasemir commented Jul 23, 2024 •
edited
Loading

How did "Symbol" get in there anyway? Symbol widget? Or was the idea to talk about "system properties" and how they correspond to "system macros"?
Maybe just delete that, so it becomes:

The following macros are predefined:

 * $(DID): The unique ID for each display. ...
 * $(DNAME): The name of the display.

@shroffk
Copy link
Member Author

shroffk commented Jul 23, 2024

I think this was inherited from eclipse CS-Studio...where regular macros are defined as symbol macros

https://control-system-studio.readthedocs.io/en/latest/app/display/editor/doc/macros.html#symbol-macros

+1 one on cleaning up

To me "symbol" should be replaced with "simple".

kasemir
kasemir approved these changes Jul 23, 2024
View reviewed changes
Copy link
Collaborator

@kasemir kasemir left a comment

Choose a reason for hiding this comment

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

Ideal

@shroffk shroffk merged commit 90c285a into master Jul 23, 2024
@shroffk shroffk deleted the doc branch July 23, 2024 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kasemir kasemir kasemir approved these changes

@georgweiss georgweiss Awaiting requested review from georgweiss

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@shroffk @kasemir