Skip to content

New-MarkdownHelp crops example code #347

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

Closed
vors opened this issue Mar 12, 2018 · 4 comments
Closed

New-MarkdownHelp crops example code #347

vors opened this issue Mar 12, 2018 · 4 comments
Assignees

Comments

@vors
Copy link
Collaborator

vors commented Mar 12, 2018

Steps to reproduce

Take https://github.com/AtlassianPS/JiraPS and generate help for the module (commit 1cdc0cb, tag v2.4.4).
New-MarkdownHelp -Module JiraPS -OutputFolder platyPS-docs.

Check the Add-JiraIssueWatcher generated markdown help for example 3.

Expected behavior

Equivalent of

    -------------------------- EXAMPLE 3 --------------------------
    
    Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | % { Add-JiraIssueWatcher "fred" }
    
    This example illustrates adding watcher on all projects which match a given JQL query. It would be best to validate 
    the query first to make sure the query returns the expected issues!  
  

Actual behavior

Cropped version


### EXAMPLE 3
```
= -5d' | % { Add-JiraIssueWatcher "fred" }
```

This example illustrates adding watcher on all projects which match a given JQL query.
It would be best to validate the query first to make sure the query returns the expected issues!

Environment data

v0.9.0

@vors vors added the bug label Mar 12, 2018
@vors
Copy link
Collaborator Author

vors commented Mar 13, 2018

@midacts this is slightly different, see #180

@midacts
Copy link

midacts commented Mar 13, 2018

Thanks for the clarification.
I thought that might be the case.

@BernieWhite
Copy link
Contributor

@vors Looks like another help engine bug. Did quick testing and the example is returned as an object with:

  • introduction = Get-JiraIssue -Query 'project = "TEST" AND created >
  • code = = -5d' | % { Add-JiraIssueWatcher "fred" }

title and remarks are as expected.

From a PlatyPS point of view the introduction not making it into the generated markdown is an issue however.

@sdwheeler
Copy link
Collaborator

No repro

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

5 participants