Skip to content

Commit

Permalink
Fix a few generated docs.
Browse files Browse the repository at this point in the history
In particular,

* fix sentences with no space after the period, like [here]([]
* switch backticks to `<code>`, like [here]([]
* link `ctx.var` [here]([]
* Add periods to the end of paragraphs, like [here]([]
* Format a list [here]([]

Closes bazelbuild#5337.

PiperOrigin-RevId: 199631585
  • Loading branch information
srawlins authored and George Gensure committed Aug 2, 2018
1 parent 66d3a9d commit 74fa9d4
Show file tree
Hide file tree
Showing 4 changed files with 571 additions and 608 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -502,19 +502,20 @@ public Runtime.NoneType addJoined(
public void useParamsFile(String paramFileArg, Boolean useAlways) throws EvalException;

@SkylarkCallable(
name = "set_param_file_format",
doc = "Sets the format of the param file when written to disk",
parameters = {
@Param(
name = "format",
type = String.class,
named = true,
doc =
"The format of the param file. Must be one of:<br>"
+ "\"shell\": All arguments are shell quoted and separated by whitespace<br>"
+ "\"multiline\": All arguments are unquoted and separated by newline characters"
+ "The format defaults to \"shell\" if not called.")
}
)
name = "set_param_file_format",
doc = "Sets the format of the param file when written to disk",
parameters = {
@Param(
name = "format",
type = String.class,
named = true,
doc =
"The format of the param file. Must be one of:<ul><li>"
+ "\"shell\": All arguments are shell quoted and separated by "
+ "whitespace</li><li>"
+ "\"multiline\": All arguments are unquoted and separated by newline "
+ "characters</li></ul>"
+ "The format defaults to \"shell\" if not called.")
})
public void setParamFileFormat(String format) throws EvalException;
}
Loading

0 comments on commit 74fa9d4

Please sign in to comment.