Skip to content
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.

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

Unclear Annotation in Documentation Example #677

Open
dan-fernandes opened this issue Nov 26, 2024 · 0 comments
Open

Unclear Annotation in Documentation Example #677

dan-fernandes opened this issue Nov 26, 2024 · 0 comments
Assignees
Milestone

Comments

@dan-fernandes
Copy link

In the Readable section of the Make a Simple Device how-to guide, the type annotation in the example code reference A:

class Sensor(StandardReadable, EpicsDevice):
    """A demo sensor that produces a scalar value based on X and Y Movers"""

    value: A[SignalR[float], PvSuffix("Value"), Format.HINTED_SIGNAL]
    mode: A[SignalRW[EnergyMode], PvSuffix("Mode"), Format.CONFIG_SIGNAL]

I am not sure it is clear that A refers to typing.Annotated, as the import alias is not shown.

Acceptance Criteria:

  • The documentation should be readable by a programmer unfamiliar with the codebase.
@coretl coretl self-assigned this Nov 26, 2024
@coretl coretl added this to the 1.0 milestone Nov 26, 2024
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

No branches or pull requests

2 participants