-
-
Notifications
You must be signed in to change notification settings - Fork 104
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
Add .gomarkdoc.yml and update docs #173
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #173 +/- ##
==========================================
- Coverage 93.48% 93.41% -0.08%
==========================================
Files 151 151
Lines 3932 3932
==========================================
- Hits 3676 3673 -3
- Misses 209 211 +2
- Partials 47 48 +1 ☔ View full report in Codecov by Sentry. |
excludeDirs: "./cmd/..." | ||
output: "{{.Dir}}/README.md" | ||
repository: | ||
url: https://github.com/cinar/indicator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
repository.url is necessary for forked repository! Otherwise, in my forked repository, the docs becomes like this.
<a name="Ad"></a>
-## type [Ad](<https://github.com/cinar/indicator/blob/master/volume/ad.go#L20-L23>)
+## type [Ad](<https://github.com/sunglim/indicator/blob/master/volume/ad.go#L20-L23>)
Ah, this is excellent, but it won't let me merge it as it is not a signed commit. Would it be possible to have it through a signed commit? Many thanks!! |
Looking at. |
Done. PTAL when you can find time. |
Thank you so much! |
Describe Request
This PR introduces
.gomarkdoc.yml
which includes default configuration of gomarkdoc.This way, we can reuse the same configuration across multiple invocations such as
pre-commit.sh
and github workflow.Also, docs are updated by executing pre-commit.sh.
Fixed # partially #172
Change Type
Docs.