Skip to content

Can we get rid of MDN in all the ScalaDoc? #553

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

Closed
japgolly opened this issue Sep 4, 2021 · 6 comments · Fixed by #554
Closed

Can we get rid of MDN in all the ScalaDoc? #553

japgolly opened this issue Sep 4, 2021 · 6 comments · Fixed by #554
Assignees
Labels

Comments

@japgolly
Copy link
Contributor

japgolly commented Sep 4, 2021

It's annoying and useless IMO. Do we really need it? A link to the actual mdn page would be great, but just stating MDN seems pretty useless to me.

If it's for licencing issues,

  1. we could just make a licencing statement upfront, once, about comments and MDN.
  2. descriptions of API aren't copyrightable anyway. Even API itself isn't copyright-able according to Google vs Oracle.
@armanbilge
Copy link
Member

See also: https://developer.mozilla.org/en-US/docs/MDN/About#copyrights_and_licenses

This is fair issue, trying to reconcile what to do.

descriptions of API aren't copyrightable anyway.

Do you have a source for this? IMO (IANAL) I would think that documentation may be copyright-able even if API isn't. Otherwise, it starts to get a bit fuzzy, where do you draw the line between e.g. copyrightable book/tutorial about how to use an API vs the documentation?

@armanbilge
Copy link
Member

See also the current LICENSE: https://github.com/scala-js/scala-js-dom/blob/master/LICENSE

@japgolly
Copy link
Contributor Author

japgolly commented Sep 4, 2021

From https://developer.mozilla.org/en-US/docs/MDN/About#copyrights_and_licenses

Please attribute "Mozilla Contributors" and include a hyperlink (online) or URL (in print) to the specific wiki page for the content being sourced

Whoops, we're already failing that pretty badly. Restoring it in each specific comment isn't feasible without automation (which let's be honest, neither of us are going to spend time on).

But we could do is declare upfront in one top-level place our usage of MDN, and then provide a link to the entire MDN. There are no rules about where exactly to place the attribution, just that we do provide attribution to MDN.

@armanbilge
Copy link
Member

But we could do is declare upfront in one top-level place our usage of MDN

Yep, that's done in scala-js-dom LICENSE I linked above.

Documentation marked "MDN" is thanks to Mozilla Contributors

Ok, so maybe here's how we get out of this: instead of indicating MDN in our scaladocs, in our license we just say all documentation is copyright MDN unless noted otherwise. So, then we'll have to mark our own docs "SJS" or something 😝

@japgolly
Copy link
Contributor Author

japgolly commented Sep 4, 2021

(1) Yeah exactly, and I think that would be better than MDN on 99.9% of all ScalaDoc.

(2) That being said I also think it would be fine to just state upfront "hey most comes from MDN, here's the link" and leave it for anyone interested (which I can't imagine ever happening) to see themselves as it's easily derivable.

But if you don't like (2), I'm happy with (1)

@armanbilge armanbilge self-assigned this Sep 4, 2021
@armanbilge
Copy link
Member

I'll PR this!

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

Successfully merging a pull request may close this issue.

2 participants