Giving the user-defined label the highest priority for add_colorbar

[FeiYao-Edinburgh]

Hi there,

I have found the following code excerpt in cartoee.add_colorbar:

    if "bands" in vis_keys:
        cb.set_label(vis_params["bands"])
    elif label is not None:
        if label_font_size is not None and label_font_family is not None:
            cb.set_label(label, fontsize=label_font_size, family=label_font_family)
        elif label_font_size is not None and label_font_family is None:
            cb.set_label(label, fontsize=label_font_size)
        elif label_font_size is None and label_font_family is not None:
            cb.set_label(label, family=label_font_family)
        else:
            cb.set_label(label)

This, from my humble view, will give the vis_params["bands"] (A list with "[]" if any) the highest priority. However, by allowing user to specify label, don't we want to give user-defined label the highest priority. If so, this can be simply done by re-ordering the codes as below:

    if label is not None:
        if label_font_size is not None and label_font_family is not None:
            cb.set_label(label, fontsize=label_font_size, family=label_font_family)
        elif label_font_size is not None and label_font_family is None:
            cb.set_label(label, fontsize=label_font_size)
        elif label_font_size is None and label_font_family is not None:
            cb.set_label(label, family=label_font_family)
        else:
            cb.set_label(label)
    elif "bands" in vis_keys:
        cb.set_label(vis_params["bands"])

Meanwhile, it might be beneficial to return cb for any post modifications.

All the best,
Fei

[giswqs]

Good suggestion. Would you like to submit a pull request so that you can get credits for this?

[FeiYao-Edinburgh]

Yes. I have made a PR following your suggestion. Note that I only made changes to cartoee.py as I do not clearly know how to update the documentation. Seems that you are using Makefile to generate the documentation automatically since there are not too many words in cartoee.md. Let me know where to edit if that's also of necessary.

[giswqs]

The suggested changes do not seem to involve documentation changes. You can submit a PR and I can help out.

I usually use VS Code the autoDocstring extension to generate docstring. Here is a video tutorial if you want to try it out.

[FeiYao-Edinburgh]

I have already submitted a PR that has passed all checks. You may review and incorporate it at a suitable time. Thanks!