Skip to content
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

capability: doc improvements #151

Merged
merged 3 commits into from
Sep 21, 2024
Merged

capability: doc improvements #151

merged 3 commits into from
Sep 21, 2024

Conversation

kolyshkin
Copy link
Collaborator

Assorted doc improvements:

  • doc: add cross-references;
  • doc: use tabs in code examples;
  • README: add link to changelog;
  • CHANGELOG: link to 0.2.0 release.

Add cross-references, and use tabs in code examples.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
@kolyshkin kolyshkin requested a review from thaJeztah September 20, 2024 17:47
kolyshkin added a commit to kolyshkin/sys that referenced this pull request Sep 20, 2024
This is a draft pending moby#151, moby#152, moby#153 merge.

TODO: fix the release date.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
kolyshkin added a commit to kolyshkin/sys that referenced this pull request Sep 20, 2024
This is a draft pending moby#151, moby#152, moby#153 merge.

TODO: fix the release date.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
capability/CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Member

@tianon tianon left a comment

Choose a reason for hiding this comment

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

Left a minor comment, but LGTM either way

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
@kolyshkin
Copy link
Collaborator Author

Merging with 1 reviewer only as it's a minor improvement which should not affect any code, and we'll be able to see the results of this in go.pkg.dev once merged (to assess if all the changes are correct and, if anything is wrong, fix before the release).

@kolyshkin kolyshkin merged commit 8c5f336 into moby:main Sep 21, 2024
19 checks passed
kolyshkin added a commit to kolyshkin/sys that referenced this pull request Sep 21, 2024
This is a draft pending moby#151, moby#152, moby#153 merge.

TODO: fix the release date.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
kolyshkin added a commit to kolyshkin/sys that referenced this pull request Sep 21, 2024
This is a draft pending moby#151, moby#152, moby#153 merge.

TODO: fix the release date.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
@kolyshkin
Copy link
Collaborator Author

Oh well, we hit this issue: golang/go#62293

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.

2 participants