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

Add .gomarkdoc.yml and update docs #173

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Add .gomarkdoc.yml and update docs #173

merged 1 commit into from
Jul 11, 2024

Conversation

sunglim
Copy link
Contributor

@sunglim sunglim commented Jul 11, 2024

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.

@codecov-commenter
Copy link

codecov-commenter commented Jul 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.41%. Comparing base (7168efc) to head (396a3ac).

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.
📢 Have feedback on the report? Share it here.

excludeDirs: "./cmd/..."
output: "{{.Dir}}/README.md"
repository:
url: https://github.com/cinar/indicator
Copy link
Contributor Author

@sunglim sunglim Jul 11, 2024

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>)

@cinar
Copy link
Owner

cinar commented Jul 11, 2024

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!!

@sunglim
Copy link
Contributor Author

sunglim commented Jul 11, 2024

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.

@sunglim
Copy link
Contributor Author

sunglim commented Jul 11, 2024

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.

@cinar cinar merged commit f956792 into cinar:master Jul 11, 2024
3 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jul 11, 2024
@cinar
Copy link
Owner

cinar commented Jul 11, 2024

Thank you so much!

@sunglim sunglim deleted the gomarkdocyml branch July 13, 2024 05:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants