Skip to content

docs(TF-36):[edgecenteredgemon] add godoc comments for Requester, RequestSigner, RequestSignerFunc interfaces#6

Merged
WispHes merged 1 commit intomainfrom
docs/TF-36-add-comments-to-requester-interfaces
Mar 6, 2026
Merged

docs(TF-36):[edgecenteredgemon] add godoc comments for Requester, RequestSigner, RequestSignerFunc interfaces#6
WispHes merged 1 commit intomainfrom
docs/TF-36-add-comments-to-requester-interfaces

Conversation

@SergeyKrasnovv
Copy link
Copy Markdown
Collaborator

This change adds missing Go documentation comments to three exported types in edgecenter/ec.go. These comments are essential for proper documentation generation on pkg.go.dev.

Changes made:

  • Added comprehensive godoc comment to Requester interface explaining its purpose as the HTTP client abstraction, who implements it (provider.Client), and providing an example method call
  • Added godoc comment to RequestSigner interface explaining its role in request signing and how it's used via provider.WithSigner
  • Added godoc comment to RequestSignerFunc adapter, including analogy with http.HandlerFunc for better understanding

Files changed:

  • edgecenter/ec.go

@SergeyKrasnovv SergeyKrasnovv requested a review from WispHes March 3, 2026 14:09
@SergeyKrasnovv SergeyKrasnovv self-assigned this Mar 3, 2026
Copy link
Copy Markdown
Collaborator

@WispHes WispHes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ты забыл добавить исправления из предыдущего пр (https://github.com/Edge-Center/edgecenteredgemon-go/pull/5/changes)

@SergeyKrasnovv SergeyKrasnovv force-pushed the docs/TF-36-add-comments-to-requester-interfaces branch from 28a8a39 to 5958cee Compare March 4, 2026 10:42
@SergeyKrasnovv SergeyKrasnovv force-pushed the docs/TF-36-add-comments-to-requester-interfaces branch from 5958cee to d70a5ac Compare March 4, 2026 10:49
@SergeyKrasnovv SergeyKrasnovv reopened this Mar 4, 2026
@SergeyKrasnovv
Copy link
Copy Markdown
Collaborator Author

Исправил

@SergeyKrasnovv
Copy link
Copy Markdown
Collaborator Author

Исправил,

@WispHes WispHes merged commit 7f68899 into main Mar 6, 2026
@WispHes WispHes deleted the docs/TF-36-add-comments-to-requester-interfaces branch March 6, 2026 12:15
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