Open lipkau opened 6 years ago
should this be a minor or a major release?
In case this gets worked on before a major release, this can be made backward compatible with aliases
My tupp'orth - it needs to be Format-JiraTable
. ConvertTo-Table
is not really what a PS user would expect.
The description of the two verbs is similar.
`PS> Get-Verb Format
Verb AliasPrefix Group Description
Format f Common Arranges objects in a specified form or layout
[09/27/2022 11:57:58] C:\Temp PS> Get-Verb ConvertTo
Verb AliasPrefix Group Description
ConvertTo ct Data Converts from one or more types of input to a primary output type (the cmdlet noun indicates the output type)`
Either verb could work, but I think "Format" is slightly better. "ConvertTo" seems to be used for more generic data types like HTML or CSV, where "Format-Jira" is for a string object with a markup language for a specific product.
It should have "Jira" as "Format-JiraTable" suggested above.
Whatever is decided, both the Confluence and Jira modules should have similar function names. Like "Format-JiraTable" and "Format-ConfluenceTable".
Expected Behavior
Format-Jira
is a misleading command name.Current Behavior
It formats an object to a jira table
Possible Solution
Use the same way as ConfluencePS does it: https://github.com/AtlassianPS/ConfluencePS/blob/master/ConfluencePS/Public/ConvertTo-Table.ps1