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.

Sign up for GitHub

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

Jump to bottom

fix mdbook test with ```ignore #7832

Closed

guswynn wants to merge 1 commit into rust-lang:master from guswynn:mdbooktest

Contributor

guswynn commented Jan 25, 2020

The rust reference repo has mdbook test as part of its CI, so when I was working on a PR here, mdbook test being broken confused me, so I figured I would make a PR to fix it.

I added some ignores to the problematic blocks (basically those with dependencies or using env vars)
and fixed some links to use formatting instead of tab formatting


          fix mdbook test with ```ignore

e3df473

ehuss self-assigned this

ehuss requested changes

View reviewed changes

Contributor

ehuss left a comment

Each code block should use the appropriate language. text disables highlighting and better conveys the intent of what the code block is for.

src/doc/src/reference/build-script-examples.md

@@ @@ -30,7 +30,7 @@ library call as part of the build script. @@
               First, let’s take a look at the directory structure of this package:
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```text

src/doc/src/reference/build-script-examples.md

               Like above, let’s first take a look at the package layout:
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```text

src/doc/src/reference/cargo-targets.md

               compile anything in the `bin` directory as an executable. Here is a sample
               layout of this scenario:
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```text

src/doc/src/reference/publishing.md

               An additional barrier to querying GitHub is that the organization may be
               actively denying third party access. To check this, you can go to:
-                  https://github.com/organizations/:org/settings/oauth_application_policy
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```text

src/doc/src/reference/registries.md

               variable instead of a config file. For example, setting the following
               environment variable will accomplish the same thing as defining a config file:
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```text

src/doc/src/reference/unstable.md

               anything. This can be useful when integrating with another build tool.
               Example:
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```sh

src/doc/src/reference/unstable.md

               time the only supported method of doing so is to add the `rust-src` rust rustup
               component:
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```console

src/doc/src/reference/unstable.md

@@ @@ -290,7 +290,7 @@ just forced to pass `--target` in one form or another. @@
               Usage looks like:
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```console

src/doc/src/reference/unstable.md

               `test` crate. If you're working with an environment which does not support some
               of these crates, then you can pass an argument to `-Zbuild-std` as well:
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```console

src/doc/src/reference/unstable.md

               The `timings` feature gives some information about how long each compilation
               takes, and tracks concurrency information over time.
-              ```
+              ```ignore

Contributor

ehuss Jan 26, 2020

Suggested change

      
            ```ignore
          
            ```sh

Contributor

bors commented Jan 31, 2020

☔ The latest upstream changes (presumably #7823) made this pull request unmergeable. Please resolve the merge conflicts.

bors added the S-waiting-on-author label

Contributor

ehuss commented Sep 3, 2020

I'm going to close, as I haven't heard back in a while. Feel free to reopen with the suggested changes, or open new PR if you're still interested.

ehuss closed this

guswynn mentioned this pull request

fix mdbook test with ```ignore/text/sh/console #8674

Merged

bors added a commit that referenced this pull request


          Auto merge of #8674 - guswynn:mdbooktest, r=ehuss

e1d3e13

fix mdbook test with ```ignore/text/sh/console

I revitalized the dead PR #7832

sorry about the delay

testing is just running `mdbook test` which now passes! Let me know if you want me to add mdbook test to ci as well!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-author