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

Generate placeholder for SYNOPSIS, instead of duplicate of SYNTAX #110

Closed
vors opened this issue May 23, 2016 · 4 comments
Closed

Generate placeholder for SYNOPSIS, instead of duplicate of SYNTAX #110

vors opened this issue May 23, 2016 · 4 comments
Assignees
Milestone

Comments

@vors
Copy link
Collaborator

vors commented May 23, 2016

Currently, we use output of Get-Help to generate SYNOPSIS and don't distinguish between a custom one and help-engine generated one.

We should make it a placeholder, if it's not present to avoid confusion and make bootstrap experience better.

@jongeller
Copy link
Contributor

@vors
So, are you saying we generate a new header called Synopsis if none exists and leave it with a note saying 'To Be Filled'?

Can you provide the example where you saw this?

@vors
Copy link
Collaborator Author

vors commented Jun 3, 2016

No, I'm saying we should do this. Currently we are putting duplicate of SYNTAX, because help engine generates defaul SYNOPSIS as duplicate of SYNTAX and we just using it.

@vors vors added this to the 0.5.0 milestone Jun 6, 2016
@jongeller jongeller self-assigned this Jun 7, 2016
@jongeller
Copy link
Contributor

How about this for the look:

Update-MarkdownHelp

SYNOPSIS

{{ Add a synopsis here. }}

SYNTAX

Update-MarkdownHelp [-Path] <String[]> [[-Encoding] <Encoding>] [[-LogPath] <String>] [-LogAppend]
 [<CommonParameters>]

@jongeller jongeller assigned vors and unassigned jongeller Jun 7, 2016
@vors
Copy link
Collaborator Author

vors commented Jun 11, 2016

Fixed per c5ac385

@vors vors closed this as completed Jun 11, 2016
@vors vors removed the in progress label Jun 12, 2016
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

No branches or pull requests

2 participants