Added test for check doc strings in crates.

#1856
This commit is contained in:
Alexander Andreev 2019-09-30 11:58:53 +03:00
parent 2b69c84396
commit fdbd6bb11a
171 changed files with 419 additions and 29 deletions

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_db::FileRange;
use ra_fmt::{leading_indent, reindent};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_syntax::{
ast::{self, AstNode, AttrsOwner},

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{db::HirDatabase, HirDisplay, Ty};
use ra_syntax::{
ast::{self, AstNode, LetStmt, NameOwner},

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use format_buf::format;
use hir::db::HirDatabase;
use join_to_string::join;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{db::HirDatabase, HasSource};
use ra_syntax::{
ast::{self, make, AstNode, NameOwner},

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{self, db::HirDatabase};
use ra_text_edit::TextEditBuilder;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_syntax::{
ast::{self, NameOwner, VisibilityOwner},

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::iter;
use hir::{db::HirDatabase, Adt, HasSource};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_syntax::ast::{AstNode, BinExpr, BinOp};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_syntax::{algo::non_trivia_sibling, Direction, T};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_syntax::{
ast::{self, AstNode, AstToken},

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use format_buf::format;
use hir::db::HirDatabase;
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::{Assist, AssistCtx, AssistId, TextRange, TextUnit};
use hir::db::HirDatabase;
use ra_syntax::ast::{AstNode, MatchArm};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_syntax::{
ast::{self, make, AstNode, NameOwner, TypeBoundsOwner},

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_syntax::{
ast,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::db::HirDatabase;
use ra_syntax::{ast::AstNode, ast::Literal, TextRange, TextUnit};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::{Assist, AssistCtx, AssistId};
use hir::db::HirDatabase;
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use format_buf::format;
use hir::db::HirDatabase;
use ra_fmt::extract_trivial_expression;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::iter::successors;
use hir::db::HirDatabase;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{iter, ops::RangeInclusive};
use arrayvec::ArrayVec;

View File

@ -1,3 +1,5 @@
//! See test_utils/src/marks.rs
test_utils::marks!(
introduce_var_in_comment_is_not_applicable
test_introduce_var_expr_stmt

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{collections::HashSet, error::Error, path::Path};
use rustc_hash::FxHashMap;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{
path::{Path, PathBuf},
sync::Arc,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{collections::HashSet, fmt::Write, path::Path, time::Instant};
use ra_db::SourceDatabase;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
pub const GLOBAL_HELP: &str = "ra-cli
USAGE:

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
mod analysis_stats;
mod analysis_bench;
mod help;

View File

@ -1,10 +1,11 @@
/// This module specifies the input to rust-analyzer. In some sense, this is
/// **the** most important module, because all other fancy stuff is strictly
/// derived from this input.
///
/// Note that neither this module, nor any other part of the analyzer's core do
/// actual IO. See `vfs` and `project_model` in the `ra_lsp_server` crate for how
/// actual IO is done and lowered to input.
//! This module specifies the input to rust-analyzer. In some sense, this is
//! **the** most important module, because all other fancy stuff is strictly
//! derived from this input.
//!
//! Note that neither this module, nor any other part of the analyzer's core do
//! actual IO. See `vfs` and `project_model` in the `ra_lsp_server` crate for how
//! actual IO is done and lowered to input.
use relative_path::{RelativePath, RelativePathBuf};
use rustc_hash::FxHashMap;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
pub(crate) mod src;
pub(crate) mod docs;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::sync::Arc;
use ra_syntax::ast;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_syntax::{
ast::{self, AstNode},
SyntaxNode,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::sync::Arc;
use ra_db::{salsa, SourceDatabase};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{any::Any, fmt};
use ra_syntax::{ast, AstNode, AstPtr, SyntaxNode, SyntaxNodePtr, TextRange};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Either<A, B> {
A(A),

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
pub(crate) mod lower;
pub(crate) mod scope;
pub(crate) mod validation;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_arena::Arena;
use ra_syntax::{
ast::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::sync::Arc;
use ra_arena::{impl_arena_id, Arena, RawId};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::sync::Arc;
use ra_syntax::ast;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_db::{FileId, FilePosition};
use ra_syntax::{
algo::find_node_at_offset,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{
hash::{Hash, Hasher},
sync::Arc,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use rustc_hash::FxHashMap;
use std::sync::Arc;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use rustc_hash::FxHashMap;
use std::sync::Arc;

View File

@ -1,5 +1,3 @@
#![recursion_limit = "512"]
//! HIR (previously known as descriptors) provides a high-level object oriented
//! access to Rust code.
//!
@ -7,6 +5,8 @@
//! to a particular crate instance. That is, it has cfg flags and features
//! applied. So, the relation between syntax and HIR is many-to-one.
#![recursion_limit = "512"]
macro_rules! impl_froms {
($e:ident: $($v:ident $(($($sv:ident),*))?),*) => {
$(

View File

@ -1,3 +1,5 @@
//! See test_utils/src/marks.rs
test_utils::marks!(
bogus_paths
name_res_works_for_broken_modules

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{panic, sync::Arc};
use parking_lot::Mutex;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::fmt;
use ra_syntax::{ast, SmolStr};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_db::FileId;
use ra_syntax::{ast, SmolStr};
use rustc_hash::FxHashMap;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::{MacroDef, ModuleDef};
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{ops::Index, sync::Arc};
use ra_arena::{impl_arena_id, map::ArenaMap, Arena, RawId};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{iter, sync::Arc};
use ra_syntax::{

View File

@ -1,10 +1,10 @@
/// Lookup hir elements using positions in the source code. This is a lossy
/// transformation: in general, a single source might correspond to several
/// modules, functions, etc, due to macros, cfgs and `#[path=]` attributes on
/// modules.
///
/// So, this modules should not be used during hir construction, it exists
/// purely for "IDE needs".
//! Lookup hir elements using positions in the source code. This is a lossy
//! transformation: in general, a single source might correspond to several
//! modules, functions, etc, due to macros, cfgs and `#[path=]` attributes on
//! modules.
//!
//! So, this modules should not be used during hir construction, it exists
//! purely for "IDE needs".
use std::sync::Arc;
use ra_db::FileId;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{
hash::{Hash, Hasher},
marker::PhantomData,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::fmt;
use crate::db::HirDatabase;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use super::{InferTy, Ty, TypeCtor};
use crate::{
expr::{BinaryOp, CmpOp},

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::fmt;
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_db::{FilePosition, FileRange};
use crate::{db::RootDatabase, SourceChange, SourceFileEdit};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_db::SourceDatabase;
use ra_syntax::{
algo::find_node_at_offset,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{fmt, sync::Arc, time};
use ra_db::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
mod completion_item;
mod completion_context;
mod presentation;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{Adt, Ty, TypeCtor};
use crate::completion::completion_item::CompletionKind;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_syntax::{
algo::visit::{visitor_ctx, VisitorCtx},
ast, AstNode,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_syntax::{
algo::visit::{visitor, Visitor},
ast::{self, LoopBodyOwner},

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::completion::{CompletionContext, Completions};
pub(super) fn complete_macro_in_item_position(acc: &mut Completions, ctx: &CompletionContext) {

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{Adt, Either, PathResolution};
use ra_syntax::AstNode;
use test_utils::tested_by;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::completion::{CompletionContext, Completions};
/// Completes constats and paths in patterns.

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::{
completion::{
completion_context::CompletionContext,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::Substs;
use crate::completion::{CompletionContext, Completions};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::Substs;
use crate::completion::{CompletionContext, Completions};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_assists::auto_import_text_edit;
use ra_syntax::{ast, AstNode, SmolStr};
use ra_text_edit::TextEditBuilder;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::completion::{
completion_item::Builder, CompletionContext, CompletionItem, CompletionItemKind,
CompletionKind, Completions,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_syntax::{
algo::{find_covering_element, find_node_at_offset},
ast, AstNode, Parse, SourceFile,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::fmt;
use hir::Documentation;

View File

@ -1,4 +1,5 @@
//! This modules takes care of rendering various definitions as completion items.
use hir::{Docs, HasSource, HirDisplay, ScopeDef, Ty, TypeWalk};
use join_to_string::join;
use ra_syntax::ast::NameOwner;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::sync::Arc;
use ra_db::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::cell::RefCell;
use hir::diagnostics::{AstDiagnostic, Diagnostic as _, DiagnosticSink};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::fmt::{self, Display};
use hir::{Docs, Documentation, HasSource};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{AssocItem, FieldSource, HasSource, ModuleSource};
use ra_db::{FileId, SourceDatabase};
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use format_buf::format;
use ra_syntax::ast::{self, AstNode, NameOwner, TypeAscriptionOwner, VisibilityOwner};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::TextRange;
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_db::SourceDatabase;
use ra_syntax::{
algo::find_covering_element,

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use rustc_hash::FxHashMap;
/// Feature flags hold fine-grained toggles for all *user-visible* features of

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use rustc_hash::FxHashSet;
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_db::{FileId, SourceDatabase};
use ra_syntax::{
algo::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_db::SourceDatabase;
use ra_syntax::{ast, AstNode};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{Adt, HasSource, HirDisplay};
use ra_db::SourceDatabase;
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{db::HirDatabase, ApplicationTy, FromSource, Ty, TypeCtor};
use ra_db::SourceDatabase;
use ra_syntax::{algo::find_node_at_offset, ast, AstNode};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::{db::RootDatabase, FileId};
use hir::{HirDisplay, SourceAnalyzer, Ty};
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use itertools::Itertools;
use ra_fmt::{compute_ws, extract_trivial_expression};
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::TextUnit;
use rustc_hash::FxHashMap;
use superslice::Ext;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::{line_index::Utf16Char, LineCol, LineIndex};
use ra_syntax::{TextRange, TextUnit};
use ra_text_edit::{AtomTextEdit, TextEdit};

View File

@ -1,3 +1,5 @@
//! See test_utils/src/marks.rs
test_utils::marks!(
inserts_parens_for_function_calls
goto_definition_works_for_macros

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_syntax::{ast::AstNode, SourceFile, SyntaxKind, TextUnit, T};
pub fn matching_brace(file: &SourceFile, offset: TextUnit) -> Option<TextUnit> {

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::sync::Arc;
use relative_path::RelativePathBuf;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::Either;
use ra_syntax::{ast, AstNode, AstPtr};
use test_utils::tested_by;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_db::{CrateId, FileId, FilePosition};
use crate::{db::RootDatabase, NavigationTarget};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use hir::{Either, ModuleSource};
use ra_db::SourceDatabase;
use ra_syntax::{algo::find_node_at_offset, ast, AstNode, SourceFile, SyntaxNode};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use itertools::Itertools;
use ra_db::SourceDatabase;
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use std::{fmt, iter::FromIterator, sync::Arc};
use hir::MacroFile;

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use rustc_hash::{FxHashMap, FxHashSet};
use hir::{Mutability, Ty};

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use crate::db::RootDatabase;
use ra_db::SourceDatabase;
use ra_syntax::{

View File

@ -1,3 +1,5 @@
//! FIXME: write short doc here
use ra_syntax::{SourceFile, TextUnit};
use ra_text_edit::TextEdit;

Some files were not shown because too many files have changed in this diff Show More