+docc prepare for docc publishing #118
Merged
Conversation
This file contains hidden or 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
tomerd
reviewed
Aug 23, 2022
tomerd
reviewed
Aug 23, 2022
tomerd
reviewed
Aug 23, 2022
yim-lee
approved these changes
Aug 23, 2022
|
|
||
| A Metrics API package for Swift. | ||
|
|
||
| Refer to `CoreMetrics` module documentation for the majority of types. No newline at end of file |
There was a problem hiding this comment.
Ah, good idea to have an index.md in each module. 👍
For me I would choose to have the detailed docs in Metrics instead because it matches the name of the package, but I'm ok either way.
There was a problem hiding this comment.
Hm... i guess better to keep "the docs" in the module which has the types since we can't link to the types otherwise -- the cross module limitation of docc -- 😢
Co-authored-by: Yim Lee <yim_lee@apple.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Resolves #115