REPORTERS_MARKDOWN_SUMMARY_TYPE confusing and lacking documentation

[bdovaz]

Is your feature request related to a problem? Please describe.

The documentation for this field is quite confusing. The possible values are as follows:

megalinter/megalinter/utils_reporter.py

Line 23 in a9d7cef

def build_markdown_summary(reporter_self, action_run_url="", max_total_chars=40000):

That is:

• sections
• sections-table
• table-sections
• table

The explanation on these pages is as follows:

Display summary in PR/MR comments as sections, table or both (sections-table or table-sections)

https://megalinter.io/latest/reporters/AzureCommentReporter/

https://megalinter.io/latest/reporters/BitbucketCommentReporter/

https://megalinter.io/latest/reporters/GitHubCommentReporter/

Honestly @nvuillam, I don't understand that explanation of the 4 possible values, let alone what each one means.

Even in Azure DevOps, setting it to REPORTERS_MARKDOWN_SUMMARY_TYPE: sections does not display anything:

Describe the solution you'd like

Explain the possible values and what each one does more clearly by showing screenshots.

Describe alternatives you've considered

Additional context

[nvuillam]

@bdovaz you can have sections, table or both , and in different order :)
This is the same for PR comments

I agree with you that it could be better documented :)

edit: I think everyone will keep default table-sections display :)

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity.
It will be closed in 14 days if no further activity occurs.
Thank you for your contributions.

If you think this issue should stay open, please remove the O: stale 🤖 label or comment on the issue.