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

autoapi documentation truncated at end of first line #1838

Closed
scottleechua opened this issue Mar 10, 2023 · 0 comments · Fixed by #2017
Closed

autoapi documentation truncated at end of first line #1838

scottleechua opened this issue Mar 10, 2023 · 0 comments · Fixed by #2017
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@scottleechua
Copy link
Contributor

Describe the bug
The CleanupOperator class has a long docstring:

class CleanupOperator(AstroSQLBaseOperator):
    """
    Clean up temporary tables at the end of a DAG run. Temporary tables are the ones that are
    generated by the SDK (where you do not pass a name arg to Table) or the ones that has the name
    that starts with ``_tmp``.

but its autogenerated documentation ends at the first line:

Screenshot 2023-03-10 at 10 10 24 PM

Version

To Reproduce
Steps to reproduce the behavior:

  1. Go to the Astro docs and look at the autogenerated (tabular) API docs.

Expected behavior
AutoAPI docs do not truncate multiline docstrings.

@pankajastro pankajastro added this to the 1.7.0 milestone Aug 11, 2023
@pankajastro pankajastro added documentation Improvements or additions to documentation bug Something isn't working labels Aug 11, 2023
tatiana pushed a commit that referenced this issue Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants