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

Improve Python documentation #1635

Conversation

jemrobinson
Copy link
Member

✅ Checklist

  • You have given your pull request a meaningful title (e.g. Enable foobar integration rather than 515 foobar).
  • You are targeting the appropriate branch. If you're not certain which one this is, it should be develop.
  • Your branch is up-to-date with the target branch (it probably was when you started, but it may have changed since then).
  • You have marked this pull request as a draft and added '[WIP]' to the title if needed (if you're not yet ready to merge).
  • You have formatted your code using appropriate automated tools (for example ./tests/AutoFormat_Powershell.ps1 -TargetPath <path to file or directory> for Powershell).

⤴️ Summary

Add some documentation about the Python code structure

🌂 Related issues

n/a

🔬 Tests

Documentation only

@jemrobinson jemrobinson requested a review from a team October 9, 2023 10:49
@jemrobinson jemrobinson force-pushed the update-python-documentation branch from 0f9b26e to 6f16895 Compare October 9, 2023 10:59
@jemrobinson jemrobinson merged commit c0d88ae into alan-turing-institute:python-migration Oct 9, 2023
6 checks passed
@jemrobinson jemrobinson deleted the update-python-documentation branch April 19, 2024 11:00
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 this pull request may close these issues.

2 participants