Skip to content

[librustdoc] Disable spellcheck for search field - #55161

Merged
bors merged 1 commit into
rust-lang:masterfrom
akxcv:rustdoc/disable-spellcheck
Oct 18, 2018
Merged

[librustdoc] Disable spellcheck for search field#55161
bors merged 1 commit into
rust-lang:masterfrom
akxcv:rustdoc/disable-spellcheck

Conversation

@akxcv

@akxcvakxcv commented Oct 17, 2018

Copy link
Copy Markdown
Contributor

This disables spellchecking for the search field in the rustdoc web interface.

As someone who uses Safari to browse through Rust docs, spellchecking gets really annoying.

@rust-highfive

rust-highfive commented Oct 17, 2018

Copy link
Copy Markdown
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @QuietMisdreavus (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 17, 2018
@QuietMisdreavus

QuietMisdreavus commented Oct 17, 2018

Copy link
Copy Markdown
Contributor

Oh nice! This makes perfect sense to me, since the things you type in there wind up being abbreviations, or combinations of words, or something else that's likely to not be in a spellcheck dictionary. I'd like to have @GuillaumeGomez take a look, but otherwise i like this.

@akxcv

akxcv commented Oct 17, 2018

Copy link
Copy Markdown
ContributorAuthor

Side note: perhaps it would be a good idea to move the HTML to an actual HTML file and use include_str! to include it into Rust code? This would enable syntax highlighting and we wouldn't need to escape double quotes.

If this is a good idea, I'm happy to submit a separate PR for this.

@GuillaumeGomez

GuillaumeGomez commented Oct 17, 2018

Copy link
Copy Markdown
Member

@akxcv It's currently not really a good idea. We're currently in a (veeeeeery slow) code improvement process in rustdoc. Once done, we'll need to think on a few things like:

  • reduce HTML output size
  • minimize HTML content in rust code as much as possible
  • write a generic "output type" so rustdoc can generate other things than HTML as well.

It'll come, but we don't know when. :)

@GuillaumeGomez

GuillaumeGomez commented Oct 17, 2018

Copy link
Copy Markdown
Member

And I forgot: thanks for the PR, looks good to me (and I learned something new, didn't know about this option)!

@bors: r=QuietMisdreavus,GuillaumeGomez rollup

@bors

bors commented Oct 17, 2018

Copy link
Copy Markdown
Collaborator

📌 Commit c55e1e6 has been approved by QuietMisdreavus,GuillaumeGomez

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 17, 2018
@akxcv

akxcv commented Oct 17, 2018

Copy link
Copy Markdown
ContributorAuthor

We're currently in a (veeeeeery slow) code improvement process in rustdoc.

I'd love to learn more about it! Where can I find a roadmap or something?

@kennytmkennytm mentioned this pull request Oct 18, 2018
Merged
kennytm added a commit to kennytm/rust that referenced this pull request Oct 18, 2018
@kennytm
Rollup merge ofrust-lang#55161- akxcv:rustdoc/disable-spellcheck, r…
7d21252
…=QuietMisdreavus,GuillaumeGomez
[librustdoc] Disable spellcheck for search field
This disables spellchecking for the search field in the rustdoc web interface.
As someone who uses Safari to browse through Rust docs, spellchecking gets really annoying.
bors added a commit that referenced this pull request Oct 18, 2018
@bors
Auto merge of#55171- kennytm:rollup, r=kennytm
af204b1
Rollup of 18 pull requests
Successful merges:
- #54646 (improve documentation on std::thread::sleep)
- #54933 (Cleanup the rest of codegen_llvm)
- #54964 (Run both lldb and gdb tests)
- #55016 (Deduplicate some code and compile-time values around vtables)
- #55031 (Improve verify_llvm_ir config option)
- #55050 (doc std::fmt: the Python inspiration is already mentioned in precedin…)
- #55077 (rustdoc: Use dyn keyword when rendering dynamic traits)
- #55080 (Detect if access to localStorage is forbidden by the user's browser)
- #55090 (regression test for move out of borrow via pattern)
- #55102 (resolve: Do not skip extern prelude during speculative resolution)
- #55104 (Add test for #34229)
- #55111 ([Rustc Book] Explain --cfg's arguments)
- #55122 (Cleanup mir/borrowck)
- #55127 (Remove HybridBitSet::dummy)
- #55128 (Fix LLVMRustInlineAsmVerify return type mismatch)
- #55142 (miri: layout should not affect CTFE checks (outside of validation))
- #55151 (Cleanup nll)
- #55161 ([librustdoc] Disable spellcheck for search field)
@bors
bors merged commit c55e1e6 into rust-lang:masterOct 18, 2018
@GuillaumeGomez

GuillaumeGomez commented Oct 19, 2018

Copy link
Copy Markdown
Member

Euh... @QuietMisdreavus and I are the roadmap? XD

@akxcv
akxcv deleted the rustdoc/disable-spellcheck branch October 19, 2018 12:38
@QuietMisdreavus

QuietMisdreavus commented Oct 19, 2018

Copy link
Copy Markdown
Contributor

Sadly the roadmap is effectively "what the two of us are most bothered by at the moment". I'd love to get a discussion together to try and focus our development. I haven't taken the opportunity to sketch something out, though.

@akxcv

akxcv commented Oct 19, 2018

Copy link
Copy Markdown
ContributorAuthor

I'd be happy to participate! I can't promise anything, but I think I might be able to help somewhat. Should I find you on IRC or something?

@QuietMisdreavus

QuietMisdreavus commented Oct 21, 2018

Copy link
Copy Markdown
Contributor

We're most active on Discord nowadays, if you want to hop on and have a chat. A real roadmap chat will probably happen in a GitHub issue somewhere, but for something slightly more synchronous, that's the current best option.

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

Reviewers

No reviews

Assignees

@QuietMisdreavusQuietMisdreavus

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@akxcv@rust-highfive@QuietMisdreavus@GuillaumeGomez@bors