mesh.reshape: Outdated docstring vs what is in code

[thibaut-kobold]

discretize/discretize/base/base_regular_mesh.py

Line 860 in d5a27bf

x_type : {'CC', 'N', 'F', 'Fx', 'Fy', 'Fz', 'E', 'Ex', 'Ey', 'Ez'}

• In the docstrings, accepted x_type : {'CC', 'N', 'F', 'Fx', 'Fy', 'Fz', 'E', 'Ex', 'Ey', 'Ez'}
• in the code, allowed_x_type = [ "cell_centers", "nodes", "faces", "faces_x", "faces_y", "faces_z", "edges", "edges_x", "edges_y", "edges_z", ]

the docstring needs to be updated

[jcapriot]

we should update the doc-string here. But also those values work in the function as well. Before the input is checked against the allowed_x_type list, they are parsed and converted from the abbreviations to the full names (e.g. 'CC' -> 'cell_centers').