JiraPS icon indicating copy to clipboard operation
JiraPS copied to clipboard

Change Format-Jira

Open lipkau opened this issue 7 years ago • 4 comments

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

lipkau avatar Nov 12 '17 14:11 lipkau

should this be a minor or a major release?

lipkau avatar Nov 12 '17 14:11 lipkau

In case this gets worked on before a major release, this can be made backward compatible with aliases

lipkau avatar Feb 05 '18 13:02 lipkau

My tupp'orth - it needs to be Format-JiraTable. ConvertTo-Table is not really what a PS user would expect.

fsackur avatar Apr 15 '21 13:04 fsackur

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".

monahancj avatar Sep 27 '22 16:09 monahancj