Skip to content

Commit

Permalink
Tweaked the style guide wording and an example (knative#3828)
Browse files Browse the repository at this point in the history
* Tweaks to style docs

* Changed title case rule to upper camel case

* Tweaked webhook mutation example
  • Loading branch information
RichardJJG authored Jul 6, 2021
1 parent eebc024 commit fb4a668
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
9 changes: 5 additions & 4 deletions docs/help/contributor/style-guide/documenting-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,17 @@
//todo

## 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

## 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"
```go
Expand Down
6 changes: 3 additions & 3 deletions docs/help/contributor/style-guide/style-and-formatting.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Formatting standard and conventions

## 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
|--------------------|-----
|Channels | `Channels`
|Channels | channels
|Broker | broker

|ContainerSource | Container Source

## Using parentheses
>Don’t use parentheses, unless it’s the first instance in a page to explain an acronym that isn’t immediately obvious.
Expand Down

0 comments on commit fb4a668

Please sign in to comment.