feat: use config.Info.Title as the page title in the API docs #346
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #346 +/- ##
=======================================
Coverage 95.25% 95.25%
=======================================
Files 19 19
Lines 2843 2846 +3
=======================================
+ Hits 2708 2711 +3
Misses 98 98
Partials 37 37 ☔ View full report in Codecov by Sentry. |
danielgtaylor
approved these changes
Apr 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Hi there, Thanks for Huma.
It's been a really nice experience so-far. As I'm using the framework to develop a third-party friendly API I saw a small improvement that could help with the experience. Feel free to close or merge ;)
What has been done
The automatic API documentation has the default title of "Elements in HTML". This PR changes that page title to something more identifiable.
Note
The change assumes that
config.Infois notnil. The GoDoc describes that it is required but I'm too new to the framework to make a educated guess if it's enforced or not.