Skip to content

Allow empty lines in lint doc examples #2428

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.

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

Merged
merged 1 commit into from
Feb 5, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions clippy_lints/src/attrs.rs
Original file line number Diff line number Diff line change
@@ -97,12 +97,11 @@ declare_lint! {
/// // Good (as inner attribute)
/// #![inline(always)]
///
/// fn this_is_fine_too(..) { ... }
/// fn this_is_fine(..) { ... }
///
/// // Good (as outer attribute)
/// #[inline(always)]
/// fn this_is_fine(..) { ... }
///
/// fn this_is_fine_too(..) { ... }
/// ```
declare_lint! {
pub EMPTY_LINE_AFTER_OUTER_ATTR,
1 change: 0 additions & 1 deletion clippy_lints/src/invalid_ref.rs
Original file line number Diff line number Diff line change
@@ -13,7 +13,6 @@ use utils::{match_def_path, opt_def_id, paths, span_help_and_lint};
/// ```rust
/// let bad_ref: &usize = std::mem::zeroed();
/// ```

declare_lint! {
pub INVALID_REF,
Warn,
11 changes: 8 additions & 3 deletions util/export.py
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ def parse_lint_def(lint):
last_section = None

for line in lint.doc:
if len(line.strip()) == 0:
if len(line.strip()) == 0 and not last_section.startswith("Example"):
continue

match = re.match(lint_subheadline, line)
@@ -39,8 +39,13 @@ def parse_lint_def(lint):
log.warn("Skipping comment line as it was not preceded by a heading")
log.debug("in lint `%s`, line `%s`", lint.name, line)

lint_dict['docs'][last_section] = \
(lint_dict['docs'].get(last_section, "") + "\n" + text).strip()
fragment = lint_dict['docs'].get(last_section, "")
if text == "\n":
line = fragment + text
else:
line = (fragment + "\n" + text).strip()

lint_dict['docs'][last_section] = line

return lint_dict