doc: Fix inconsistency in documentation of Gitea integration #1165
Conversation
The text says that the extra information is added in a `gitea` nested object, but it's in fact a `remote` object according to the examples.
|
Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️ |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1165 +/- ##
==========================================
+ Coverage 41.95% 42.00% +0.06%
==========================================
Files 21 21
Lines 1981 1981
==========================================
+ Hits 831 832 +1
+ Misses 1150 1149 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
They are actually added as both, e.g. for GitHub: "github": {
"username": "LitoMore",
"pr_title": "docs(readme): fix twitter badge",
"pr_number": 1164,
"pr_labels": [],
"is_first_time": false
},
"remote": {
"username": "LitoMore",
"pr_title": "docs(readme): fix twitter badge",
"pr_number": 1164,
"pr_labels": [],
"is_first_time": false
},For context, the So in this case we should probably expand the docs to say something like " |
|
Hmm, yeah then I don't know how to formulate in a way that's not confusing… if you write " |
|
Makes sense. Then we need to change this to |
|
Congrats on merging your first pull request! ⛰️ |
…rhun#1165) * Fix inconsistency in documentation of Gitea integration The text says that the extra information is added in a `gitea` nested object, but it's in fact a `remote` object according to the examples. * Do the same for other forges
…rhun#1165) * Fix inconsistency in documentation of Gitea integration The text says that the extra information is added in a `gitea` nested object, but it's in fact a `remote` object according to the examples. * Do the same for other forges
…rhun#1165) * Fix inconsistency in documentation of Gitea integration The text says that the extra information is added in a `gitea` nested object, but it's in fact a `remote` object according to the examples. * Do the same for other forges
The text says that the extra information is added in a
giteanested object, but it's in fact aremoteobject according to the examples.Description
Motivation and Context
How Has This Been Tested?
Screenshots / Logs (if applicable)
Types of Changes
Checklist: