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

Notes section lacks bullets #125

Closed
TimShererAtAquent opened this issue Jun 6, 2016 · 4 comments
Closed

Notes section lacks bullets #125

TimShererAtAquent opened this issue Jun 6, 2016 · 4 comments
Assignees
Milestone

Comments

@TimShererAtAquent
Copy link

Any topic that has a notes section, such as Receive-PSSession, New-PSSessionOption and Register-PSSessionConfiguration.

The markdown output has no bullets. The technet version has bullets (see screen cap).

In the maml file, there is a tag, maml:alert, which wraps one or more maml:para tags. The technet page renders one bullet for each maml:alert tag, which can include multiple paragraphs. Can we get this as a list, one bullet per alert tag?

notes section in technet

notes in md

@vors
Copy link
Collaborator

vors commented Jun 6, 2016

Yes, we can do it in New-MarkdownHelp.

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

vors commented Jun 12, 2016

That turned out to be a trickier problem, then I expected.

As @TimShererAtAquent said, in maml, there is <maml:para> tag that provides bullet-point.
However, help object doesn't have any corresponding entity.

We use help object to produce markdown.

So, if we want this functionality, we need to plug it before converting maml into help object.

Also, in the Get-Help output itself this distinctions creates problems already

For example, here is a fragment of output of Get-Help Receive-PSSession
image

And corresponding technet article

image

So this is not new, but we can try to solve it with platyPS.

@vors
Copy link
Collaborator

vors commented Jun 12, 2016

I made it work, but markdown doesn't look good eather
https://gist.github.com/vors/c06c7876bbe400fc9a3dc93e65d2c9d0#notes

vors pushed a commit that referenced this issue Jun 12, 2016
This commit addresses #125
However, generated markdown doesn't look pretty.
Leaving this option for evaluation for next release.
@vors
Copy link
Collaborator

vors commented Jun 12, 2016

Addressed in 69d5663 and 8c6e40e

New-MarkdownHelp -ConvertNotesToList

@vors vors closed this as completed Jun 12, 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