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

doc: add example for digest and parseReference #670

Closed
wants to merge 1 commit into from

Conversation

sajayantony
Copy link
Contributor

@sajayantony sajayantony commented Jan 4, 2024

Using this PR to discuss the need for importing the hash algorithm. One option is that add this to the examples for digest or parse reference or it possible to have indirect dependencies. I'm leaning towards not having an indirect dependency since this means that if and when a algorithm becomes unacceptable the library has to rev. Instead clients taking the appropriate imports could define the actual hash algorithms that are being used -
https://cloud-native.slack.com/archives/CJ1KHJM5Z/p1704365828594969

On a side note, how what would be a good pattern to exclude full file examples from license header check?

Related to - #671

Copy link

codecov bot commented Jan 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0b78aa6) 75.46% compared to head (fa2b729) 75.46%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #670   +/-   ##
=======================================
  Coverage   75.46%   75.46%           
=======================================
  Files          59       59           
  Lines        5640     5640           
=======================================
  Hits         4256     4256           
  Misses       1019     1019           
  Partials      365      365           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sajayantony sajayantony marked this pull request as draft January 4, 2024 23:45
@shizhMSFT
Copy link
Contributor

On a side note, how what would be a good pattern to exclude full file examples from license header check?

Don't worry about the license headers. You can just add them in the source file and they will be ignored by godoc generation.
Examples can be found at:

Wwwsylvia pushed a commit that referenced this pull request Jan 10, 2024
@shizhMSFT
Copy link
Contributor

Closing this PR as it is succeeded by #675 and whole file example can be found on godoc.

@shizhMSFT shizhMSFT closed this Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants