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

Document new to_string function #63

Closed
jojoelfe opened this issue Jul 23, 2024 · 4 comments
Closed

Document new to_string function #63

jojoelfe opened this issue Jul 23, 2024 · 4 comments

Comments

@jojoelfe
Copy link
Collaborator

If you have time, @jahooker, that would be great!

@jahooker
Copy link
Contributor

At the moment, to_string already has a docstring (which I unimaginatively copied from the docstring of write. What else would constitute documentation of to_string?

@jojoelfe
Copy link
Collaborator Author

That is a good question . Maybe adding a line to docs/index.md? Maybe it would also be a good idea to autogenerate some docs from the doc_strings, but I can also look into this.

Also, I just noticed the link to the documentation in the readme is broken. @alisterburt I'll look into how to fix this, but I might have to trouble you...

@alisterburt
Copy link
Collaborator

@jojoelfe oops - I'm in the process of putting together a new teamtomo.org site which links out to the various package... that isn't quite done but I've already moved the existing site to https://github.com/teamtomo/teamtomo-site-archive

I wasn't expecting child sites teamtomo.org/starfile etc to be affected but I guess they need a parent - this will be fixed once I've pushed the new site to github, sorry about that! 🙂

@jojoelfe
Copy link
Collaborator Author

@alisterburt no worries, just wanted to point it out.

@jahooker unless there is something you want to add, this might just be done by #64

https://teamtomo.github.io/starfile/

@jojoelfe jojoelfe closed this as completed Aug 8, 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

3 participants