Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Appendix: Legend does not correspond to colours used for same license and copyright notice #1256

Open
mschoettle opened this issue Nov 25, 2024 · 12 comments

Comments

@mschoettle
Copy link
Contributor

The appendix uses different colour tones for the columns "same license" and "license and copyright notice".

However, in the legend on the bottom the same blue-ish colour tone is used for all items of those categories. It would be good to match what is used in the table.

@mlinksva
Copy link
Contributor

I see the same used for both columns:

Image

Could you clarify?

@mschoettle
Copy link
Contributor Author

Thanks for the quick response. I should have added a screenshot in the issue right away.

image

See the different colour tones used in the "same license" column.

The legend, however, looks as follows:

image

Another small issue is that the same darker colour tone is used for "same license (file)" and "same license (library)" although that might be intended?

@mlinksva
Copy link
Contributor

Yes the muted colours are intended for lighter versions of conditions. They should be used in the key, thanks for noticing this discrepancy!

@mlinksva
Copy link
Contributor

Looks like the reason is there's a bit of special handling of conditions with -- in their name only in the appendix table, should be in the key/legend as well. And probably elsewhere, but a start would be to make this page consistent.

{% if r contains "--" %}
{% assign lite = " lite" %}
{% else %}
{% assign lite = "" %}
{% endif %}
<span class="{{ r | append: lite }}" style="margin: auto;">
<span class="license-sprite {{ r }}"></span>
</span>

A pull request to fix would be welcome, or I'll get to it eventually.

@mschoettle
Copy link
Contributor Author

Thanks! I will see if I can create a PR for it.

Would it be ok to also add a third colour (in a separate PR) for "same license" so that each of the three are represented by a different one?

@mlinksva
Copy link
Contributor

Great!

Not sure I understand what you have in mind re adding a third colour. My intent is to have all conditions be blue, but lighter versions of conditions be a muted blue. Do you have a different scheme in mind?

@mschoettle
Copy link
Contributor Author

Ah, I see.

The issue I faced when reviewing differences between licenses was that "same license" has three different versions and only two different colours. The difference in "same license (file)" and "same license (library)" is very minimal so that it was difficult to figure out which of the two the darker dot belonged to. That's why I propose to introduce a third muted blue.

Additionally, I think it could be helpful to add the rule label to the tooltip, and the type to the legend in order to not have to rely on colour alone.

@mlinksva
Copy link
Contributor

Thanks for those PRs! Fine with me to include the rule label in the tooltip.

I think different shades for each variation would be hard to discern unless you really know what you're looking for.

@mlinksva
Copy link
Contributor

After merging I noticed a small issue with each of the two PRs, left a comment and review comment. In case you're inspired to look, please do, otherwise I will eventually.

@mschoettle
Copy link
Contributor Author

After merging I noticed a small issue with each of the two PRs, left a comment and review comment. In case you're inspired to look, please do, otherwise I will eventually.

Thanks for merging and sorry about that. I'll have a look.

Thanks for those PRs! Fine with me to include the rule label in the tooltip.

I think different shades for each variation would be hard to discern unless you really know what you're looking for.

Yes, that's true. Adding the rule label in the tooltip would alleviate this anyway.

Any suggestions on where to add it specifically? I tried the following:

image

@mlinksva
Copy link
Contributor

Seems like a fine place, though two :s are ugly. Maybe Same license (library) condition: or even elide condition if latter isn't easy?

@mschoettle
Copy link
Contributor Author

Great idea! It's actually easy and works with all types based on a quick look.

PR that adds the label and fixes the tooltips is coming.

For the second issue I have to look a bit more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants