Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-08-08 06:55:31 +01:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #6668 - servo:untruncated-docs, r=Ms2ger

Browse source 
Make doc comments not truncated again.

`rustdoc --passes "collapse-docs unindent-comments"` doesn’t work is intended. It still generate HTML files that look alright at a glance, but all doc-comments are truncated to their first line for some reason I don’t understand.

See http://doc.servo.org/script/dom/index.html for example. The module documentation there is currently just “The implementation of the DOM.”, but clicking the [src] link shows a much larger doc-comment.

The correct invocation is to use `--passes` multiple times.

https://github.com/rust-lang/rust/issues/15347#issuecomment-122785714

<!-- Reviewable:start -->
[<img src="https://reviewable.io/review_button.png" height=40 alt="Review on Reviewable"/>](https://reviewable.io/reviews/servo/servo/6668)
<!-- Reviewable:end -->
This commit is contained in:
bors-servo 2015-07-19 19:32:41 -06:00
commit 685a44e1f5
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
etc/rustdoc-with-private
View file

@ -1,4 +1,4 @@
#!/bin/sh #!/bin/sh
# Skip the strip-private and strip-hidden rustdoc passes # Skip the strip-private and strip-hidden rustdoc passes
# https://github.com/rust-lang/rust/issues/15347 # https://github.com/rust-lang/rust/issues/15347
rustdoc --no-defaults --passes "collapse-docs unindent-comments" "$@" rustdoc --no-defaults --passes collapse-docs --passes unindent-comments "$@"