Skip to content

Commit

Permalink
update package docs
Browse files Browse the repository at this point in the history
  • Loading branch information
VictorAvelar committed Oct 12, 2024
1 parent 59d6f1b commit ffadc9a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 23 deletions.
24 changes: 11 additions & 13 deletions .github/workflows/documentation-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,15 @@ jobs:
- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@7da8ec1fc4e01b5a12062ac6c589c10a4ce70d67
with:
args: --no-progress './**/*.md'

- name: Create Issue From File
if: env.lychee_exit_code != 0
uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd
with:
title: Link Checker Report
content-filepath: ./lychee/out.md
labels: |
report
automated-issue
help-wanted
assignees: VictorAvelar
# - name: Create Issue From File
# if: env.lychee_exit_code != 0
# uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd
# with:
# title: Link Checker Report
# content-filepath: ./lychee/out.md
# labels: |
# report
# automated-issue
# help-wanted
# assignees: VictorAvelar
1 change: 0 additions & 1 deletion .lycheeignore

This file was deleted.

14 changes: 5 additions & 9 deletions mollie/doc.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
// Package mollie is a wrapper around Mollie's REST API.
//
// See: https://www.mollie.com/en/developers
// See: https://www.mollie.com/developers
//
// The Mollie API implements a Representational state transfer (REST) architecture.
//
// Sounds technical, but it’s really quite easy. It mainly breaks down to HTTP-methods
// GET, PATCH, POST and DELETE matching the operations to read, update, create and delete.
//
// REST also implies a nice and clean structure for URLs or endpoints.
// This means you can reach any part of the Mollie API on https://api.mollie.com/v2/ adding
// the name of the resource you want to interact with.
// The Mollie API is a straightforward REST API. This means all endpoints
// either create, retrieve, or update objects. API calls are authenticated
// with an [API credential](https://docs.mollie.com/reference/authentication).
// In some cases, you can receive live updates via [webhooks](https://docs.mollie.com/reference/webhooks).
package mollie

0 comments on commit ffadc9a

Please sign in to comment.