Skip to content

Improve docs for Appender, RefAppender#4987

Merged
JackStouffer merged 4 commits intodlang:masterfrom
ntrel:appender-docs
Jan 10, 2017
Merged

Improve docs for Appender, RefAppender#4987
JackStouffer merged 4 commits intodlang:masterfrom
ntrel:appender-docs

Conversation

@ntrel
Copy link
Contributor

@ntrel ntrel commented Dec 22, 2016

  • Expand some docs.
  • Inline undocumented T, AppenderType.
  • Merge opOpAssign overloads.
  • Document RefAppender.opDispatch.
  • Rename appender(E[]*) parameter -> arrayPtr to better distinguish from
    appender(E[]).

std/array.d Outdated

private alias T = ElementEncodingType!A;
///
package alias T = ElementEncodingType!A;
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of documenting this, it would make more sense to replace it in the signitures.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Also added 3 other commits.

@ntrel ntrel force-pushed the appender-docs branch 3 times, most recently from d62c197 to a129751 Compare December 26, 2016 16:05
@ntrel
Copy link
Contributor Author

ntrel commented Jan 8, 2017

CircleCI fails:

+ git -C ../tools checkout 184f5e60372d6dd36d3451b75fb6f21e23f7275b
fatal: reference is not a tree: 184f5e60372d6dd36d3451b75fb6f21e23f7275b

Looks like a CI bug. Although the test is not required, this makes my PR get a red cross in the PR list, and presumably reviewers ignore it.

@wilzbach
Copy link
Contributor

wilzbach commented Jan 8, 2017

Looks like a CI bug. Although the test is not required, this makes my PR get a red cross in the PR list, and presumably reviewers ignore it.

IIRC the bug has been fixed in the script - rebasing your branch to upstream/master should fix it.

ntrel and others added 4 commits January 9, 2017 09:09
* Expand some docs.
* Document (Ref)Appender.T as it's used in public method signatures.
* Document RefAppender.opDispatch.
* Inline undocumented AppenderType.
* Rename appender(E[]*) parameter -> arrayPtr to better distinguish from
  appender(E[]).
Also avoids private symbols in RefAppender constraint.
@ntrel
Copy link
Contributor Author

ntrel commented Jan 9, 2017

@wilzbach Thanks ;-)

@JackStouffer
Copy link
Contributor

Auto-merge toggled on

@JackStouffer JackStouffer merged commit de51b31 into dlang:master Jan 10, 2017
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.

3 participants