Skip to content
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

Update templates.md #341

Closed
wants to merge 2 commits into from
Closed

Update templates.md #341

wants to merge 2 commits into from

Conversation

dataPulverizer
Copy link

I have replaced the current templates tour with a highly detailed tutorial on generic and metaprogramming in D.

Thanks

Copy link

@pbackus pbackus left a comment

Choose a reason for hiding this comment

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

This is a decent first draft of a comprehensive survey of metaprogramming topics in D. Unfortunately, that makes it a poor fit for the D tour, which wants short, focused, introductory articles on individual topics.

If you would like to submit any of this content for inclusion in the D tour, please split it into individual pages, each no more than 200 lines in length and focused on a single language feature or programming technique. Some of the material (for example, the part on CTFE) could also be submitted as improvements to existing tour pages.

@wilzbach
Copy link
Member

wilzbach commented Sep 3, 2020

Thanks a lot for helping out! I don't have time atm to review in-depth, but a first comment: is there a possibility to split this into two or three sections?
At the moment most sections of the tour are roughly one page, so that the user isn't over-whelmed with content.

@dataPulverizer
Copy link
Author

dataPulverizer commented Sep 3, 2020 via email

@dataPulverizer
Copy link
Author

I shall rework this and split it into a few sections.

@PetarKirov
Copy link
Member

PetarKirov commented Sep 4, 2020

@dataPulverizer I think that the following file structure would be the organization that best fits the tour:

tour/
├── ...
├── metaprogramming
│   ├── 00-intro.md
│   ├── 01-ct-sequences-intro.md
│   ├── 02-ct-sequences-algos.md
│   ├── 03-ctfe.md
│   └── 04-string-mixins.md
└── templates
    ├── 00-intro.md
    ├── 01-function-templates.md
    ├── 02-struct-class-interface-templates.md
    ├── 03-enum-templates.md
    ├── 04-alias-templates.md
    └── 05-mixin-templates.md

@dataPulverizer
Copy link
Author

dataPulverizer commented Sep 4, 2020

@PetarKirov

I'm happy to do this but I created a separate PR #342 after cancelling this one. Shall I delete the new PR? I'm happy to do so if it is clearer. I created it because for some reason I didn't realise I could re-submit a different document structure in this PR. From the above comments before yours, I thought people wanted something smaller and more brief, both for each document and for the overall length, which is why the new PR contains a small fraction of my initial PR split over different documents. Shall I reopen and work within this PR so the history is retained? If so I can put the original material into the structure you have specified and do another PR.

Please confirm.

Thanks.

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