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.

Sign up for GitHub

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

Jump to bottom

Proposal: <placeholder> documentation element #1766

Open
sharwell opened this issue Aug 2, 2018 · 1 comment
Open

Proposal: <placeholder> documentation element #1766

sharwell opened this issue Aug 2, 2018 · 1 comment
Assignees
@DustinCampbell
Labels
Blocked Waiting for a dependency Proposal champion Proposal
Milestone
Backlog

Comments

@sharwell
Copy link
Member

sharwell commented Aug 2, 2018

I propose updating the C# language specification to include a mention of a <placeholder> element in documentation. This "inline" element identifies content that is not yet finalized and/or needs further review.

One primary advantage of the <placeholder> element is documentation generation scenarios. Generated documentation content can be placed inside <placeholder> elements to encourage review prior to final acceptance.

🔗 placeholder (Sandcastle MAML Guide)
🔗 SA1651: Do not use placeholder elements (StyleCop Analyzers)
@sharwell
Copy link
Member Author

sharwell commented Aug 2, 2018

/cc @EWSoftware

@DustinCampbell DustinCampbell self-assigned this Sep 17, 2018
@MadsTorgersen MadsTorgersen added this to the X.0 candidate milestone Sep 19, 2018
@MadsTorgersen MadsTorgersen added the Blocked Waiting for a dependency label Sep 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DustinCampbell DustinCampbell

Labels
Blocked Waiting for a dependency Proposal champion Proposal
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
3 participants
@DustinCampbell @sharwell @MadsTorgersen