Skip to content

std.range: document public methods#4313

Merged
andralex merged 1 commit into
dlang:masterfrom
wilzbach:public_document_range
Jun 18, 2016
Merged

std.range: document public methods#4313
andralex merged 1 commit into
dlang:masterfrom
wilzbach:public_document_range

Conversation

@wilzbach

Copy link
Copy Markdown
Contributor

follow-up to #4312

Comment thread std/range/package.d Outdated
public:
@property inout(T) front() inout { return _value; }
@property inout(T) back() inout { return _value; }
///

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should have comment like "Range primitives"

@wilzbach
wilzbach force-pushed the public_document_range branch from a8db4aa to 716c3c3 Compare May 27, 2016 03:21
@wilzbach

Copy link
Copy Markdown
Contributor Author

Why did you expand all the other primitives, but not this one? And why expand them at all? Is there a rule on this in the style guidelines?

I think most of the code had the "long style", but I don't remember anymore.
Reverted the changes as this should only be about documenting all public methods + addressed other comments.

@wilzbach
wilzbach force-pushed the public_document_range branch 2 times, most recently from 59a67d0 to cc10651 Compare May 27, 2016 03:26
Comment thread std/range/package.d Outdated
}

// Nonstandard
/// Nonstandard

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're going to want something a little more descriptive here. What about this is non-standard and why does that matter?

@JackStouffer

Copy link
Copy Markdown
Contributor

Everything else looks good

@wilzbach
wilzbach force-pushed the public_document_range branch from cc10651 to 493c989 Compare June 3, 2016 20:39
@JackStouffer

Copy link
Copy Markdown
Contributor

LGTM

Comment thread std/range/package.d
}

/**
This template simply aliases itself to R and is useful for consistency in

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

R in code font

@andralex

Copy link
Copy Markdown
Member

will pull, feel free to address the nit in a later pass

@andralex
andralex merged commit b3cf5d5 into dlang:master Jun 18, 2016
@wilzbach
wilzbach deleted the public_document_range branch June 18, 2016 10:47
jmdavis pushed a commit to jmdavis/phobos that referenced this pull request Jul 15, 2026
Reword first paragraph (partly as class variadics are deprecated).
Explain array variadics, make it clearer an array can be passed.
Make examples runnable; use `assert`.
Explain basic type variadic. Fixes dlang#4311.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants