Skip to content

Improve Markdown output for enum expansion #69

@atmamont

Description

@atmamont

Summary

Here is an partial example of enum change when one enum case is being expanded. New enum cases are not displayed as they usually go into the "Added" section.

// From
case boleto

// To
@available(*, deprecated, renamed: "boletoBancarioSantander", message: "Use 'boletoBancarioSantander' instead. Consider 'boletoBancario' as the default payment method for Boleto Bancario.") case boleto

Screenshot of how it looks as Github comment

image

Proposed solution

Add newline break between annotation and case itself:

// From
case boleto

// To
@available(*, deprecated, renamed: "boletoBancarioSantander", message: "Use 'boletoBancarioSantander' instead. Consider 'boletoBancario' as the default payment method for Boleto Bancario.") 
case boleto

Describe alternatives you've considered
The only alternative at the moment is to pay 100% attention to the change set, follow and dissect every change.

Metadata

Metadata

Assignees

Labels

enhancementIndicates new feature requests

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions