docs: fix a couple of minor docs typos/mistakes #460
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
trogowski
commented
Sep 4, 2024
|
|
||
| ```python | ||
| import k8spkg.api.core.v1 |
There was a problem hiding this comment.
Looks like this package no longer exists
trogowski
commented
Sep 4, 2024
| @@ -604,6 +604,12 @@ mixin PersistentVolumeClaimMixin for PVCProtocol: | |||
| } | |||
| ``` | |||
|
|
|||
| > Note: for the `k8s.api.core.v1` import to work, we need to initialize a module and add the `k8s` module as a dependency: | |||
There was a problem hiding this comment.
This is the first time in this doc where external dependencies are used. Perhaps it's worth mentioning how to run this example.
trogowski
commented
Sep 4, 2024
| @@ -450,7 +450,7 @@ _priorityCpuMap = { | |||
| "3" = 1024 | |||
| } | |||
| # Using a dict to simplify logic and the default value is 2048 | |||
| _cpu = _priorityCpuMap[_priority] or 2048 | |||
| _cpu = _priorityCpuMap[str(_priority)] or 2048 | |||
There was a problem hiding this comment.
This example would originally always return 2048 regardless of priority as the dict expects an str as the key.
Signed-off-by: Tim Rogowski <[email protected]>
trogowski
force-pushed
the
fix-docs-typos
branch
from
1574eb2 to
51103c0
Compare
|
Good Catch! LGTM. |
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.
1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):
2. What is the scope of this PR (e.g. component or file name):
Docs in
kcl-lang.io\docs\reference\lang\codelab3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):
4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):
5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links: