Documentation: Rename subheaders in Reference section #239
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 subheadersDecorator Reference
,Driver Reference
,GraphAdapter Reference
, andResultBuilder Reference
have been shortened toDecorators
,Drivers
,GraphAdapters
, andResultBuilders
, respectively. This change improves readability and reduces redundancy in the documentation.Summary of Changes
index.rst
file underdocs/reference/decorators
:Decorator Reference
toDecorators
.index.rst
file underdocs/reference/drivers
:Driver Reference
toDrivers
.index.rst
file underdocs/reference/graph-adapters
:GraphAdapter Reference
toGraphAdapters
.index.rst
file underdocs/reference/result-builders
:ResultBuilder Reference
toResultBuilders
.Fixes #217.