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: Rename subheaders in Reference section #239

Merged
merged 8 commits into from
Jul 27, 2023

Conversation

wwzeng1
Copy link
Contributor

@wwzeng1 wwzeng1 commented Jul 27, 2023

This PR was copied from sweepai-dev#11 and generated by Sweep.
Resolves #217.


Description

This PR addresses issue #217 by renaming the subheaders in the Reference section of the documentation. The subheaders Decorator Reference, Driver Reference, GraphAdapter Reference, and ResultBuilder Reference have been shortened to Decorators, Drivers, GraphAdapters, and ResultBuilders, respectively. This change improves readability and reduces redundancy in the documentation.

Summary of Changes

  • Modified index.rst file under docs/reference/decorators:
    • Changed subheader title from Decorator Reference to Decorators.
  • Modified index.rst file under docs/reference/drivers:
    • Changed subheader title from Driver Reference to Drivers.
  • Modified index.rst file under docs/reference/graph-adapters:
    • Changed subheader title from GraphAdapter Reference to GraphAdapters.
  • Modified index.rst file under docs/reference/result-builders:
    • Changed subheader title from ResultBuilder Reference to ResultBuilders.

Fixes #217.

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks -- this is cool @wwzeng1 would love to chat a bit more about your internal set up for this process -- since we think Hamilton can help express the workflow your sweep bot is doing.!

@skrawcz skrawcz merged commit f6886bb into DAGWorks-Inc:main Jul 27, 2023
@wwzeng1
Copy link
Contributor Author

wwzeng1 commented Jul 27, 2023

Sweet! @skrawcz I'll connect with you

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.

Documentation - Rename subheaders
2 participants