procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Escape ` and ' in doc

Browse source 
Escape apostrophes and grave accents in docstrings if they are
are supposed to stand for themselves and are not quotes.  Remove
apostrophes from docstring examples like ‘'(calendar-nth-named-day
-1 0 10 year)’ that confuse source code with data.  Do some other
minor docstring fixups as well, e.g., insert a missing close
quote.
This commit is contained in:
Paul Eggert 2015-09-01 18:21:42 -07:00
parent 5dc644a6b0
commit 19532d147b
43 changed files with 127 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lisp/progmodes/verilog-mode.el
View file

@ -12794,7 +12794,7 @@ Constant signals:
is put into the AUTOSENSE list and is not desired, use the AUTO_CONSTANT
declaration anywhere in the module (parenthesis are required):
/* AUTO_CONSTANT ( `this_is_really_constant_dont_autosense_it ) */
/* AUTO_CONSTANT ( \\=`this_is_really_constant_dont_autosense_it ) */
Better yet, use a parameter, which will be understood to be constant
automatically.
@ -12810,16 +12810,16 @@ OOps!
An example:
always @ (/*AS*/) begin
/* AUTO_CONSTANT (`constant) */
outin = ina | inb | `constant;
/* AUTO_CONSTANT (\\=`constant) */
outin = ina | inb | \\=`constant;
out = outin;
end
Typing \\[verilog-auto] will make this into:
always @ (/*AS*/ina or inb) begin
/* AUTO_CONSTANT (`constant) */
outin = ina | inb | `constant;
/* AUTO_CONSTANT (\\=`constant) */
outin = ina | inb | \\=`constant;
out = outin;
end
@ -12827,7 +12827,7 @@ Note in Verilog 2001, you can often get the same result from the new @*
operator. (This was added to the language in part due to AUTOSENSE!)
always @* begin
outin = ina | inb | `constant;
outin = ina | inb | \\=`constant;
out = outin;
end"
(save-excursion