knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tweaked the style guide wording and an example (#3828) 

* Tweaks to style docs

* Changed title case rule to upper camel case

* Tweaked webhook mutation example
This commit is contained in:
RichardJJG 2021-07-06 11:57:20 +01:00 committed by GitHub
parent eebc024fa1
commit fb4a66893b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/help/contributor/style-guide/documenting-code.md
View File

@ -4,16 +4,17 @@
//todo //todo
## Words requiring code formatting ## Words requiring code formatting
Use code formatting to indicate special purpose text. Apply code formatting to the following content: Apply code formatting only to special-purpose text:
* Filenames and path names * Filenames
* Path names
* Any text that goes into a CLI * Any text that goes into a CLI
## Specify the programming language ## Specify the programming language
> Be sure to specify the language your code is in as part of the code block > Specify the language your code is in as part of the code block
> Specify non-language specific code, like CLI commands, specify ```bash (see below for formatting). > Specify non-language specific code, like CLI commands, with ```bash (see below for formatting).
=== ":white_check_mark: Correct" === ":white_check_mark: Correct"
```go ```go

6
docs/help/contributor/style-guide/style-and-formatting.md
View File

@ -1,13 +1,13 @@
# Formatting standard and conventions # Formatting standard and conventions
## Documenting Knative API Objects ## Documenting Knative API Objects
> Any Knative API Objects ought to use Title case. > Use upper camel case for Knative API objects.
|:white_check_mark: Correct |:no_entry: Incorrect |:white_check_mark: Correct |:no_entry: Incorrect
|--------------------|----- |--------------------|-----
|Channels | `Channels` |Channels | channels
|Broker | broker |Broker | broker
|ContainerSource | Container Source
## Using parentheses ## Using parentheses
>Don’t use parentheses, unless it’s the first instance in a page to explain an acronym that isn’t immediately obvious. >Don’t use parentheses, unless it’s the first instance in a page to explain an acronym that isn’t immediately obvious.