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

Docstring of phases displays phase descriptor #877

Open
Minipada opened this issue Apr 29, 2019 · 0 comments · May be fixed by #878
Open

Docstring of phases displays phase descriptor #877

Minipada opened this issue Apr 29, 2019 · 0 comments · May be fixed by #878

Comments

@Minipada
Copy link
Contributor

I'm trying to generate a sphinx documentation of my apps but the only output I get from my phase documentation is the phase descriptor class.

This is what I'm running:

#!/usr/bin/env python
"""OPENHTF based motor control test"""
from __future__ import division, print_function
import openhtf as htf

@htf.measures(htf.Measurement('hello_world_measurement'))
def hello_world(test):
  """A hello world test phase."""
  test.logger.info('Hello World!')
  test.measurements.hello_world_measurement = 'Hello Again!'


if __name__ == '__main__':
    print(hello_world.__doc__)
    pass

This is the output:

Phase function and related information.

  Attributes:
    func: Function to be called (with TestApi as first argument).
    options: PhaseOptions instance.
    plugs: List of PhasePlug instances.
    measurements: List of Measurement objects.
    extra_kwargs: Keyword arguments that will be passed to the function.
    code_info: Info about the source code of func.

I guess something is broken, do you know what it could be?

Minipada pushed a commit to Minipada/openhtf that referenced this issue Apr 29, 2019
@Minipada Minipada linked a pull request Apr 29, 2019 that will close this issue
Minipada pushed a commit to synapticon/openhtf that referenced this issue Apr 30, 2019
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 a pull request may close this issue.

1 participant