Doctests failing due to mismatch in unsorted output.

[dalonsoa]

Description

The doctest in parameters_cli.list_parameters sometimes fails due to the output of os.walk being in different order than the expected output. Adding sorted(package_dirs) when printing the output ensures the consistency of the output.

The output of the test before this bug fix was:

Warning, treated as error:
**********************************************************************
File "../pybamm/parameters_cli.py", line ?, in default
Failed example:
    list_parameters(["lithium-ion", "anodes"])
Expected:
    Available package parameters:
      * graphite_Ecker2015
      * graphite_Chen2020
      * graphite_mcmb2528_Marquis2019
      * graphite_UMBL_Mohtat2020
      * graphite_Kim2011
    Available local parameters:
Got:
    Available package parameters:
      * graphite_Chen2020
      * graphite_Ecker2015
      * graphite_Kim2011
      * graphite_UMBL_Mohtat2020
      * graphite_mcmb2528_Marquis2019
    Available local parameters:

Correct values but wrong order. After sorting the directories, and updating the expected output, to the new - alphabetical - order, the tests pass.

Fixes: None

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

Key checklist:

• No style issues: $ flake8
• All tests pass: $ python run-tests.py --unit
• The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[valentinsulzer]

Thanks @dalonsoa !

[valentinsulzer]

Not sure why the CI isn't starting. I'll just merge ...