Skip to content

Improve Compile-time sequences docs#2204

Merged
wilzbach merged 7 commits intodlang:masterfrom
ntrel:ct-seq
Mar 11, 2018
Merged

Improve Compile-time sequences docs#2204
wilzbach merged 7 commits intodlang:masterfrom
ntrel:ct-seq

Conversation

@ntrel
Copy link
Contributor

@ntrel ntrel commented Feb 12, 2018

@dlang-bot
Copy link
Contributor

dlang-bot commented Feb 12, 2018

Thanks for your pull request and interest in making D better, @ntrel! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please verify that your PR follows this checklist:

  • My PR is fully covered with tests (you can see the annotated coverage diff directly on GitHub with CodeCov's browser extension
  • My PR is as minimal as possible (smaller, focused PRs are easier to review than big ones)
  • I have provided a detailed rationale explaining my changes
  • New or modified functions have Ddoc comments (with Params: and Returns:)

Please see CONTRIBUTING.md for more information.


If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment.

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

Add headings.
Mention .tupleof.
@wilzbach
Copy link
Contributor

@ntrel your fork seems to be out of date.

Copy link
Contributor

@wilzbach wilzbach left a comment

Choose a reason for hiding this comment

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

A few nits. I definitely like the direction! Thanks a lot!

Ddoc

$(D_S Compile-time Argument Lists,
$(D_S $(TITLE)),
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

commonly exist in other languages. Sequences of values of different types that can be
returned from functions are provided by $(LINK2 phobos/std_typecons.html#.Tuple, std.typecons.Tuple).
Using term "tuple" to mean compile-time lists is discouraged to avoid confusion, and if encountered
returned from functions are provided by $(PHOBOS typecons, .Tuple, std.typecons.Tuple).
Copy link
Contributor

Choose a reason for hiding this comment

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

$(REF Tuple, std, typecons)

)

$(H2 $(LNAME2 homogenous-lists, Homogenous lists))
$(H2 $(LNAME2 homogenous-sequences, Homogenous sequences))
Copy link
Contributor

Choose a reason for hiding this comment

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

LEGACY_LNAME2 to avoid breakage?

---

$(P It is possible to use expression lists with values of the same type to declare array literals:)
$(P $(B Note:) $(PHOBOS typecons, .Tuple, std.typecons.Tuple) wraps a type sequence instance,
Copy link
Contributor

Choose a reason for hiding this comment

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

$(REF Tuple, std, typecons)

different values) refer to $(LINK2 phobos/std_typecons.html#tuple, Phobos documentation on std.typecons.tuple)

You may be also looking for documentation for built-in $(LINK2 ctarguments.html, compile-time argument lists)
You may be also looking for documentation for built-in $(LINK2 ctarguments.html, compile-time sequences)
Copy link
Contributor

@wilzbach wilzbach Feb 15, 2018

Choose a reason for hiding this comment

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

While you are at it, you could update the link to articles/ctarguments.html (not required, there are redirects)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Haven't done this, but fixed the other points. Thanks for reviewing.

Copy link
Contributor

@wilzbach wilzbach left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

_=

$(COMMENT Should be used only when link text is not std.$1.$2 - use REF instead)
PHOBOS=$(SPANC phobos, $(AHTTPS dlang.org/phobos/std_$1.html#$2, $(TAIL $+)))
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's simply get rid of this deprecated macro: #2195

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, reverted.

@wilzbach
Copy link
Contributor

(used the git commit --amend trick to restart DAutoTest)

@ntrel
Copy link
Contributor Author

ntrel commented Feb 27, 2018

@wilzbach Tests pass now ;-) Also I removed the comment for the PHOBOS macro so as not to conflict with your pull.

@wilzbach wilzbach merged commit 496dd44 into dlang:master Mar 11, 2018
@ntrel ntrel deleted the ct-seq branch April 11, 2018 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants