doc: add link to examples #1719
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
As a new user of this library, looking into the Readme and docs for the first time, I struggled to find the amazing(!) complete examples provided in the documentation. IMHO thus giving a short link there, that there are more examples, is very helpful!
|
Those examples are designed to be included in the API Reference docs and aren't really designed as standalone examples. It would be more appropriate to link to the samples directory, but I don't really see the point of that since it's in the file listing at the top of the GitHub page. |
Improve the wording and link to Documentation/Examples
|
How about this modified verbiage/link instead? |
rklec
added a commit
to rklec/MailKit
that referenced
this pull request
Mar 1, 2024
|
Ah yeah, also found the But I saw you've merged it in 51462a1.
Don't know, do you like that more? Usually that's not necessary AFAIK as GitHub automatically expands links. Created #1720 for the samples dir now. |
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.
As a new user of this library, looking into the Readme and docs for the first time, I struggled to find the amazing(!) complete examples provided in the documentation.
IMHO thus giving a short link there, that there are more examples, is very helpful!