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

Address documentation/docstring TODOs #840

Merged
merged 19 commits into from
Dec 13, 2024
Merged

Conversation

dwinston
Copy link
Collaborator

Related subsystem(s)

  • Runtime API (except the Minter)
  • Minter
  • Dagster
  • Project documentation (in the docs directory)
  • Translators (metadata ingest pipelines)
  • MongoDB migrations
  • Other

Testing

  • I tested these changes (explain below)
  • I did not test these changes

I tested these changes by...

Documentation

  • I have not checked for relevant documentation yet (e.g. in the docs directory)
  • I have updated all relevant documentation so it will remain accurate
  • Other (explain below)

Maintainability

  • Every Python function I defined includes a docstring (test functions are exempt from this)
  • I used black to format all the Python files I created/modified
  • The PR title is in the imperative mood (e.g. "Do X") and not the declarative mood (e.g. "Does X" or "Did X")

@dwinston dwinston merged commit fa94fd5 into main Dec 13, 2024
2 checks passed
@dwinston dwinston deleted the update-documentation-todos branch December 13, 2024 17:39
@dwinston dwinston mentioned this pull request Dec 13, 2024
12 tasks
@eecavanna
Copy link
Collaborator

Thank you, @dwinston! I just saw this PR here (while looking for a different one). I think this will make it easier for people to navigate and maintain the code base.

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.

4 participants