QuietMisdreavus QuietMisdreavus

(This is a mirror of the main working group document, for those who can't access Dropbox Paper.)

Rustdoc issue roundup (WG-docs-rustdoc)

Lead: QuietMisdreavus
Chat: WG-docs-rustdoc
Rustdoc is part of the main Rust repo, so it uses Rust’s Contribution Guidelines

Getting Started

Look through the “Any issue marked A-rustdoc" or the “Curated list” links below and find something that sounds interesting. Soon i’d like to have more issues with mentoring instructions - i’ll add a proper link to “A-rustdoc + E-mentor" once i’m okay with it - but for now i’ll have to start with the daunting full list. >_>

Agenda (September 11th) - RLS clients

Current status overview
Other editors status
- xi: work hasn't seriously started yet (i think there may be an initial prototype) but would like to later this fall
see also: https://insights.stackoverflow.com/survey/2017#technology-most-popular-developer-environments-by-occupation
What can we do for extension implementors?
- refactoring to make life easier
- important documentation
config options

layout	title	date	categories
post	come work on rustdoc!	2017-09-08 10:00 -0500	code

To participate in the Rust core team's ["impl period"][], i'm helping out by organizing for contributions to [rustdoc][], the first-party documentation generator!

the Great Big List of rustdoc issues (incomplete; last updated 2017-08-07)

i'm trying to fill this in over time giving an initial impression of what a given issue takes to solve.

last issue categorized: 20524

https://github.com/rust-lang/rust/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3AA-rustdoc%20sort%3Acreated-asc%20created%3A%3E2015-01-04

for tips on how to mess with rustdoc, check out "a whirlwind tour of rustdoc"

infobar project

desired features

animated!
- scrolling background
  - two-tone patterns
  - album art/picture collage?
- marquee text
piecewise text region fill

	require 'twitter_ebooks'

	# bot code shamelessly stolen from https://github.com/mispy/ebooks_example

	# Information about a particular Twitter user we know
	class UserInfo
	attr_reader :username

	# @return [Integer] how many times we can pester this user unprompted
	attr_accessor :pesters_left

	// This Source Code Form is subject to the terms of the Mozilla Public
	// License, v. 2.0. If a copy of the MPL was not distributed with this
	// file, You can obtain one at http://mozilla.org/MPL/2.0/.

	extern crate egg_mode;

	mod common;

	use common::tokio_core::reactor;
	use common::futures::Stream;

	Compiling rocket v0.4.0-dev (file:///home/misdreavus/clones/rocket-git/lib)
	Documenting rocket v0.4.0-dev (file:///home/misdreavus/clones/rocket-git/lib)
	warning: this expression is being lifted blindly

	warning: this expression is being lifted blindly

	warning: this expression is being lifted blindly

	WARNING: documentation for this crate may be rendered differently using the new Pulldown renderer.
	See https://github.com/rust-lang/rust/issues/44229 for details.

	Compiling serde v1.0.12
	Documenting serde v1.0.12
	WARNING: documentation for this crate may be rendered differently using the new Pulldown renderer.
	See https://github.com/rust-lang/rust/issues/44229 for details.
	WARNING: rendering difference in `# Serde...`
	--> /home/misdreavus/.cargo/registry/src/github.com-1ecc6299db9ec823/serde-1.0.12/src/lib.rs:9:0
	/html[0]/body[1] Attributes differ in `h1`: expected: `{"id": "serde-1", "class": "section-header"}`, found: `{"id": "serde", "class": "section-header"}`
	/html[0]/body[1] Attributes differ in `h2`: expected: `{"id": "design-1", "class": "section-header"}`, found: `{"class": "section-header", "id": "design"}`
	/html[0]/body[1] Attributes differ in `h2`: expected: `{"id": "data-formats-1", "class": "section-header"}`, found: `{"id": "data-formats", "class": "section-header"}`
	WARNING: rendering difference in `Generic data structure deserialization framework....`