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

Documentation improvements. #356

Open
1 of 8 tasks
JoeZiminski opened this issue Apr 8, 2024 · 1 comment
Open
1 of 8 tasks

Documentation improvements. #356

JoeZiminski opened this issue Apr 8, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@JoeZiminski
Copy link
Member

JoeZiminski commented Apr 8, 2024

A couple of additions to improve the new version of the documentation:

  • time the tutorial and add how long it will take to top
  • check all public docstrings that appear on the API and the API reference in general
  • Add docs on the coincident transfer issue.
  • Sample script ('Tutorials')
  • Document that show transfer status is only available for non-ssh transfer setup
  • Document that all validation on TUI is local.
  • Fix all build warnings.
  • document the dry_run argument.
@JoeZiminski JoeZiminski added the enhancement New feature or request label Apr 8, 2024
@JoeZiminski
Copy link
Member Author

Open PR to sollicit docs feedback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant