Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do something sensible with rustdoc/demo.rs #3731

Closed
catamorphism opened this issue Oct 11, 2012 · 3 comments
Closed

Do something sensible with rustdoc/demo.rs #3731

catamorphism opened this issue Oct 11, 2012 · 3 comments
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@catamorphism
Copy link
Contributor

FIXME says "It would be nice if we could run some automated tests on this file". Now that include_str exists, that's possible.

@pnkfelix
Copy link
Member

@catamorphism is your thinking here that we would automatically include the contents of demo.rs into another file that applies some functions from librustdoc to the included text, just to ensure that nothing hangs/segfaults? Or was there some strategy for checking that the documentation output conforms to some expected value?

(I'm in part trying to understand why include_str was the missing piece of the puzzle ... the kinds of tests I was imagining seem like they would work with files just as well as with included-strings.

(I know you didn't write the original comment, so if you don't have an idea of what the intention was, feel free to say so. :)

@catamorphism
Copy link
Contributor Author

@pnkfelix Hmm, I no longer remember what I was talking about :-) Your reasoning seems sound to me.

@emberian
Copy link
Member

emberian commented Aug 5, 2013

Subsuming under rustdoc_ng; closing.

@emberian emberian closed this as completed Aug 5, 2013
bors added a commit that referenced this issue Feb 3, 2019
submodule: update clippy from 6ce78d1 to 3bda548

rust-lang/rust-clippy@6ce78d1...3bda548

Rustup: unused trim result
Auto merge of #3727 - phansch:rustup_unused_trim, r=matthiaskrgr  …
Travis: Don't run integration tests on every PR commit  …
Auto merge of #3726 - phansch:some_renaming, r=oli-obk  …
Fix ICE in vec_box lint and add run-rustfix  …
Make vec_box MachineApplicable
Remove conditionals from base builds  …
Adding lint for too many lines.
Updating number of lines for the failing test to be > 100.  …
Running util/dev to update README/CHANGELOG
Reworking function logic, and adding doc example.  …
Moving tests to ui-toml to make use of clippy.toml
rustfmt
Adding back tests, but also reducing threshold by 1
Updating to just warn for one test.
Fix test broken by removing comment.
Skipping check if in external macro.
Adding lint for too many lines.
Updating number of lines for the failing test to be > 100.  …
Moving tests to ui-toml to make use of clippy.toml
rustfmt
Adding back tests, but also reducing threshold by 1
Updating to just warn for one test.
Fix test broken by removing comment.
Changing single character string to a character match.
Updated readme.
Updating code to ignore rustfmt issue.
phansch and avborhanian
Update clippy_lints/src/types.rs  …
Update clippy_lints/src/types.rs  …
Auto merge of #3732 - phansch:fix_ice_3720, r=oli-obk  …
Auto merge of #3731 - phansch:travis, r=phansch  …
Auto merge of #2857 - avborhanian:master, r=phansch  …
Fix breakage due to #58079  …
Auto merge of #3736 - mikerite:fix-build-20190203, r=phansch  …

related with: #58024
bors pushed a commit to rust-lang-ci/rust that referenced this issue May 15, 2021
RalfJung pushed a commit to RalfJung/rust that referenced this issue Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants