Add documentation from docs.mollie.com #195
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pimm
force-pushed
the
pimm/documentation-copy
branch
from
20fd61c
to
580a779
Compare
edorivai
approved these changes
Jan 29, 2021
I am currently experimenting with a tool which finds the documentation on docs.mollie.com referenced by @see-lines in the source code, and then injects that documentation.
Pimm
force-pushed
the
pimm/documentation-copy
branch
from
580a779
to
0a0c06c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I copied documentation from docs.mollie.com into the source code using my new experimental tool atsee.
Before this pull request, this library had some of the documentation on docs.mollie.com copied into the source code by hand, while some methods/properties were "naked": lacking any documentation.
Naked methods/properties are unfortunate, as developers might have to take a trip out of their IDE to look something up. However, copying over documentation by hand has the risk of the copy in the source code becoming outdated. (Copying over things by hand is not being a particularly fun chore, either).
This might be a healthy compromise. The copied-over documentation should improve the user experience, while the automation of the copying process makes it easy to keep the source code in sync with docs.mollie.com.