From c175e97a8862be5c87196aa94cb911975c84cf84 Mon Sep 17 00:00:00 2001 From: Xavier Claessens Date: Tue, 25 Feb 2020 10:19:50 -0500 Subject: summary: Add list_sep keyword argument This allows having lists on a single line instead of having each value aligned on a new line. --- docs/markdown/snippets/summary.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/markdown/snippets/summary.md (limited to 'docs/markdown/snippets') diff --git a/docs/markdown/snippets/summary.md b/docs/markdown/snippets/summary.md new file mode 100644 index 0000000..2ab7996 --- /dev/null +++ b/docs/markdown/snippets/summary.md @@ -0,0 +1,5 @@ +## Summary improvements + +A new `list_sep` keyword argument has been added to `summary()` function. +If defined and the value is a list, elements will be separated by the provided +string instead of being aligned on a new line. -- cgit v1.1 From 8101b0ddab1dea8de3b2588a4b75da525865c404 Mon Sep 17 00:00:00 2001 From: Xavier Claessens Date: Tue, 25 Feb 2020 10:29:47 -0500 Subject: summary: Add more info in Subprojects section This adds a warnings counter for subprojects that passed. This is to encourage developpers to check warnings in the logs and hopefully fix them. Otherwise they could be hidden in hundreds lines of logs. This also print the error message for subprojects that did not pass. The error message is often enough to fix the issue (e.g. missing dependency) and it's easier than searching in the logs why a subproject failed. --- docs/markdown/snippets/summary.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/markdown/snippets') diff --git a/docs/markdown/snippets/summary.md b/docs/markdown/snippets/summary.md index 2ab7996..67f29da 100644 --- a/docs/markdown/snippets/summary.md +++ b/docs/markdown/snippets/summary.md @@ -3,3 +3,6 @@ A new `list_sep` keyword argument has been added to `summary()` function. If defined and the value is a list, elements will be separated by the provided string instead of being aligned on a new line. + +The automatic `subprojects` section now also print the number of warnings encountered +during that subproject configuration, or the error message if the configuration failed. -- cgit v1.1