Skip to content

Move to docc documentation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 23, 2022
Merged

Move to docc documentation #19

merged 2 commits into from
Aug 23, 2022

Conversation

ktoso
Copy link
Member

@ktoso ktoso commented Aug 2, 2022

Resolves #18

@ktoso ktoso force-pushed the ktoso-patch-1 branch 2 times, most recently from 8d86d38 to 1efc24b Compare August 2, 2022 12:33
@ktoso ktoso requested a review from yim-lee August 2, 2022 12:44
@ktoso
Copy link
Member Author

ktoso commented Aug 2, 2022

The nightly failure is somethign we must fix independently: #17

@ktoso ktoso added this to the 0.2.0 milestone Aug 2, 2022
Copy link
Member

@yim-lee yim-lee left a comment

Choose a reason for hiding this comment

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

Some minor suggestions. LGTM overall.

Perhaps should wait for the outcome of the discussion around Package.swift in apple/swift-statsd-client#36 before merging.


This makes the System Metrics API available. This adds a new method to `MetricsSystem` called `bootstrapWithSystemMetrics`. Calling this method will call `MetricsSystem.bootstrap` as well as bootstrapping System Metrics.

`bootstrapWithSystemMetrics` takes a `SystemMetrics.Configuration` object to configure the system metrics. The config has the following properties:
Copy link
Member

Choose a reason for hiding this comment

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

Can these references be links? (i.e., ``SystemMetrics.Configuration``)

Copy link
Member Author

Choose a reason for hiding this comment

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

Sadly not across modules :-(

@yim-lee
Copy link
Member

yim-lee commented Aug 2, 2022

Added CI for Swift 5.6 and 5.7.

@swift-server-bot test this please

@ktoso
Copy link
Member Author

ktoso commented Aug 3, 2022

Okey I chimed in on apple/swift-statsd-client#36

THanks for review!

ktoso added 2 commits August 23, 2022 15:08
some initial docc preparation

remove jazzy

we need ruby still

formatting

docker cleanups

some more docs for the types

Apply suggestions from code review

Co-authored-by: Yim Lee <[email protected]>

license fix
@ktoso ktoso merged commit f353124 into main Aug 23, 2022
@ktoso ktoso deleted the ktoso-patch-1 branch August 23, 2022 06:17
@@ -88,7 +88,7 @@ for language in swift-or-c bash dtrace; do
matching_files=( -name '*' )
case "$language" in
swift-or-c)
exceptions=( -name c_nio_http_parser.c -o -name c_nio_http_parser.h -o -name cpp_magic.h -o -name Package.swift -o -name CNIOSHA1.h -o -name c_nio_sha1.c -o -name ifaddrs-android.c -o -name ifaddrs-android.h)
exceptions=( -name Package.swift -o -name Package@*.swift )
Copy link
Member

Choose a reason for hiding this comment

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

I think we need quotes around Package@*.swift.

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks!

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.

Move to docc docs
3 participants