tools/godoc: Fix indentation in doc contents
Mobile-friendly design overlooked indentation in table of contents for article table of contents; this change restores indentation. Change-Id: I9a3013497e1659ebfb657a8fb9374b8ad9b04b16 Reviewed-on: https://go-review.googlesource.com/11582 Reviewed-by: Andrew Gerrand <adg@golang.org>
This commit is contained in:
parent
a87e08b564
commit
9febd36660
|
@ -78,7 +78,7 @@ function generateTOC() {
|
||||||
if ($(node).is('h2')) {
|
if ($(node).is('h2')) {
|
||||||
item = $('<dt/>');
|
item = $('<dt/>');
|
||||||
} else { // h3
|
} else { // h3
|
||||||
item = $('<dd/>');
|
item = $('<dd class="indent"/>');
|
||||||
}
|
}
|
||||||
item.append(link);
|
item.append(link);
|
||||||
toc_items.push(item);
|
toc_items.push(item);
|
||||||
|
|
|
@ -39,18 +39,6 @@ var Files = map[string]string{
|
||||||
results in the source and package views. This document provides a
|
results in the source and package views. This document provides a
|
||||||
brief tour of these features.
|
brief tour of these features.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
|
||||||
The current status of the analysis features is that of a technology
|
|
||||||
preview; there are many problems and user-interface difficulties
|
|
||||||
which will be addressed in due course. Some known problems are
|
|
||||||
mentioned in passing, accompanied by a warning triangle, <span
|
|
||||||
style='font-size:120%; color:darkred; background-color:
|
|
||||||
yellow'>⚠</span>.
|
|
||||||
|
|
||||||
Nonetheless, godoc's static analysis may be immediately useful today
|
|
||||||
for small-to-medium sized Go corpora, and it contains several
|
|
||||||
advances over the state of the art in code browsing.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h2>Type analysis features</h2>
|
<h2>Type analysis features</h2>
|
||||||
<p>
|
<p>
|
||||||
|
@ -71,10 +59,6 @@ var Files = map[string]string{
|
||||||
displays the error message.
|
displays the error message.
|
||||||
</p>
|
</p>
|
||||||
<img class="ss" width='811' src='error1.png'><br/>
|
<img class="ss" width='811' src='error1.png'><br/>
|
||||||
<p>
|
|
||||||
<span class='err'>⚠</span> The mark-up for compilation errors may
|
|
||||||
cause duplication of portions of the input.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3>Identifier resolution</h3>
|
<h3>Identifier resolution</h3>
|
||||||
<p>
|
<p>
|
||||||
|
@ -135,8 +119,8 @@ var Files = map[string]string{
|
||||||
channel.
|
channel.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
Pointer analysis is slower than type analysis, taking an additional
|
Compared to type analysis, pointer analysis requires more time and
|
||||||
15 seconds or so for the standard libraries and their tests.
|
memory, and is impractical for code bases exceeding a million lines.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h3>Call graph navigation</h3>
|
<h3>Call graph navigation</h3>
|
||||||
|
@ -270,21 +254,24 @@ var Files = map[string]string{
|
||||||
|
|
||||||
<h2>Known issues</h2>
|
<h2>Known issues</h2>
|
||||||
<p>
|
<p>
|
||||||
<span class='err'>⚠</span> All analysis results pertain to exactly
|
All analysis results pertain to exactly
|
||||||
one configuration (e.g. amd64 linux). Files that are conditionally
|
one configuration (e.g. amd64 linux). Files that are conditionally
|
||||||
compiled based on different platforms or build tags are not visible
|
compiled based on different platforms or build tags are not visible
|
||||||
to the analysis.<br/>
|
to the analysis.
|
||||||
|
</p>
|
||||||
<span class='err'>⚠</span> Files that <code>import "C"</code> require
|
<p>
|
||||||
|
Files that <code>import "C"</code> require
|
||||||
preprocessing by the cgo tool. The file offsets after preprocessing
|
preprocessing by the cgo tool. The file offsets after preprocessing
|
||||||
do not align with the unpreprocessed file, so markup is misaligned.<br/>
|
do not align with the unpreprocessed file, so markup is misaligned.
|
||||||
|
</p>
|
||||||
<span class='err'>⚠</span> Files are not periodically re-analyzed.
|
<p>
|
||||||
|
Files are not periodically re-analyzed.
|
||||||
If the files change underneath the running server, the displayed
|
If the files change underneath the running server, the displayed
|
||||||
markup is misaligned.<br/>
|
markup is misaligned.
|
||||||
|
</p>
|
||||||
<span class='err'>⚠</span> Additional issues are listed at
|
<p>
|
||||||
<a href='https://go.googlesource.com/tools/+/master/godoc/analysis/README'>tools/godoc/analysis/README</a>.<br/>
|
Additional issues are listed at
|
||||||
|
<a href='https://go.googlesource.com/tools/+/master/godoc/analysis/README'>tools/godoc/analysis/README</a>.
|
||||||
</p>
|
</p>
|
||||||
`,
|
`,
|
||||||
|
|
||||||
|
@ -656,7 +643,7 @@ function generateTOC() {
|
||||||
if ($(node).is('h2')) {
|
if ($(node).is('h2')) {
|
||||||
item = $('<dt/>');
|
item = $('<dt/>');
|
||||||
} else { // h3
|
} else { // h3
|
||||||
item = $('<dd/>');
|
item = $('<dd class="indent"/>');
|
||||||
}
|
}
|
||||||
item.append(link);
|
item.append(link);
|
||||||
toc_items.push(item);
|
toc_items.push(item);
|
||||||
|
@ -2830,6 +2817,9 @@ dl {
|
||||||
dd {
|
dd {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
}
|
}
|
||||||
|
dd.indent {
|
||||||
|
margin: 0 20px;
|
||||||
|
}
|
||||||
dl,
|
dl,
|
||||||
dd {
|
dd {
|
||||||
font-size: 14px;
|
font-size: 14px;
|
||||||
|
|
|
@ -106,6 +106,9 @@ dl {
|
||||||
dd {
|
dd {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
}
|
}
|
||||||
|
dd.indent {
|
||||||
|
margin: 0 20px;
|
||||||
|
}
|
||||||
dl,
|
dl,
|
||||||
dd {
|
dd {
|
||||||
font-size: 14px;
|
font-size: 14px;
|
||||||
|
|
Loading…
Reference in New Issue