Check rustc_middle docs for method return type

Looking at the following method:

rust/compiler/rustc_middle/src/middle/region.rs

Lines 451 to 457 in 9310aff

    
               /// Checks whether the given scope contains a `yield`. If so, 
        
               /// returns `Some((span, expr_count))` with the span of a yield we found and 
        
               /// the number of expressions and patterns appearing before the `yield` in the body + 1. 
        
               /// If there a are multiple yields in a scope, the one with the highest number is returned. 
        
               pub fn yield_in_scope(&self, scope: Scope) -> Option<YieldData> { 
        
                   self.yield_in_scope.get(&scope).cloned() 
        
               }

Are the docs here correct that this "returns Some((span, expr_count))"? From the code, it looks like the Some case returns a Some(YieldData). Looks like the docs should be updated to reflect the YieldData type.

I think this doc comment is just outdated, feel free to file a PR updating it

@rustbot

@rustbot claim

Rollup merge of rust-lang#80302 - pierwill:fix-80287, r=lcnr

Navigation Menu

Repository navigation

Check rustc_middle docs for method return type #80287

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	/// Checks whether the given scope contains a `yield`. If so,
	/// returns `Some((span, expr_count))` with the span of a yield we found and
	/// the number of expressions and patterns appearing before the `yield` in the body + 1.
	/// If there a are multiple yields in a scope, the one with the highest number is returned.
	pub fn yield_in_scope(&self, scope: Scope) -> Option<YieldData> {
	self.yield_in_scope.get(&scope).cloned()
	}

Check rustc_middle docs for method return type #80287

Description

Activity

LeSeulArtichaut commented on Dec 22, 2020

pierwill commented on Dec 22, 2020

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions