Add even more docs

crates/hir_expand/src/name.rs

@@ -1,4 +1,4 @@
-//! FIXME: write short doc here
+//! See [`Name`].
 
 use std::fmt;
 

crates/mbe/src/subtree_source.rs

@@ -1,4 +1,6 @@
-//! FIXME: write short doc here
+//! Our parser is generic over the source of tokens it parses.
+//!
+//! This module defines tokens sourced from declarative macros.
 
 use parser::{Token, TokenSource};
 use syntax::{lex_single_syntax_kind, SmolStr, SyntaxKind, SyntaxKind::*, T};

crates/mbe/src/syntax_bridge.rs

@@ -1,4 +1,4 @@
-//! FIXME: write short doc here
+//! Conversions between [`SyntaxNode`] and [`tt::TokenTree`].
 
 use parser::{FragmentKind, ParseError, TreeSink};
 use rustc_hash::FxHashMap;

crates/mbe/src/tt_iter.rs

@@ -1,4 +1,5 @@
-//! FIXME: write short doc here
+//! A "Parser" structure for token trees. We use this when parsing a declarative
+//! macro definition into a list of patterns and templates.
 
 use crate::{subtree_source::SubtreeTokenSource, ExpandError, ExpandResult};
 

crates/parser/src/grammar.rs

@@ -27,6 +27,7 @@
 //! node or an error, rules like `opt_where_clause` may produce nothing.
 //! Non-opt rules typically start with `assert!(p.at(FIRST_TOKEN))`, the
 //! caller is responsible for branching on the first token.
+
 mod attributes;
 mod expressions;
 mod items;

crates/parser/src/grammar/attributes.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) fn inner_attrs(p: &mut Parser) {

crates/parser/src/grammar/expressions.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 mod atom;
 
 pub(crate) use self::atom::{block_expr, match_arm_list};

crates/parser/src/grammar/expressions/atom.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 // test expr_literals

crates/parser/src/grammar/items.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 mod consts;
 mod adt;
 mod traits;

crates/parser/src/grammar/items/adt.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) fn strukt(p: &mut Parser, m: Marker) {

crates/parser/src/grammar/items/consts.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) fn static_(p: &mut Parser, m: Marker) {

crates/parser/src/grammar/items/traits.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 // test trait_item

crates/parser/src/grammar/items/use_item.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) fn use_(p: &mut Parser, m: Marker) {

crates/parser/src/grammar/params.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 // test param_list

crates/parser/src/grammar/paths.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) const PATH_FIRST: TokenSet =

crates/parser/src/grammar/patterns.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) const PATTERN_FIRST: TokenSet =

crates/parser/src/grammar/type_args.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) fn opt_generic_arg_list(p: &mut Parser, colon_colon_required: bool) {

crates/parser/src/grammar/type_params.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) fn opt_generic_param_list(p: &mut Parser) {

crates/parser/src/grammar/types.rs

@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use super::*;
 
 pub(super) const TYPE_FIRST: TokenSet = paths::PATH_FIRST.union(TokenSet::new(&[

crates/parser/src/parser.rs

@@ -1,4 +1,4 @@
-//! FIXME: write short doc here
+//! See [`Parser`].
 
 use std::cell::Cell;
 

crates/parser/src/syntax_kind.rs

@@ -1,4 +1,5 @@
-//! FIXME: write short doc here
+//! Defines [`SyntaxKind`] -- a fieldless enum of all possible syntactic
+//! constructs of the Rust language.
 
 #[macro_use]
 mod generated;

xtask/src/tidy.rs

@@ -348,7 +348,7 @@ struct TidyDocs {
 impl TidyDocs {
     fn visit(&mut self, path: &Path, text: &str) {
         // Tests and diagnostic fixes don't need module level comments.
-        if is_exclude_dir(path, &["tests", "test_data", "fixes"]) {
+        if is_exclude_dir(path, &["tests", "test_data", "fixes", "grammar"]) {
             return;
         }
 
@@ -392,7 +392,7 @@ fn finish(self) {
             )
         }
 
-        let poorly_documented = ["hir_expand", "mbe", "parser", "hir_ty"];
+        let poorly_documented = ["hir_ty"];
 
         let mut has_fixmes =
             poorly_documented.iter().map(|it| (*it, false)).collect::<HashMap<&str, bool>>();