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

Ambiguous link guidance #2860

Merged
merged 4 commits into from
Jul 13, 2023
Merged

Ambiguous link guidance #2860

merged 4 commits into from
Jul 13, 2023

Conversation

j-mie6
Copy link
Contributor

@j-mie6 j-mie6 commented Jul 9, 2023

When working with Scaladoc, it can be annoying to work out the correct way of dealing with ambiguous links.

This PR adds a section to the "Scaladoc for Library Authors" page to address this, clearing up exactly how this should be done. There appear to be a couple of bugs/holes in the disambiguator, so I've added them there as cautionary tales too.

(Compiler should now point at this page instead of its own quick guide, implemented in scala/scala#10458, pending this merging).

@SethTisue SethTisue self-assigned this Jul 9, 2023
Copy link
Contributor

@som-snytt som-snytt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tweaks and typos. Lots of good information.

If I select "request changes", then I'm on the hook to re-review?

It's already very useful info. The text can be amended later, if desired. Or now, if possible.

_overviews/scaladoc/for-library-authors.md Outdated Show resolved Hide resolved
_overviews/scaladoc/for-library-authors.md Outdated Show resolved Hide resolved
_overviews/scaladoc/for-library-authors.md Show resolved Hide resolved
_overviews/scaladoc/for-library-authors.md Outdated Show resolved Hide resolved
_overviews/scaladoc/for-library-authors.md Outdated Show resolved Hide resolved
_overviews/scaladoc/for-library-authors.md Outdated Show resolved Hide resolved
@SethTisue
Copy link
Member

@julienrf does the Center have a Scaladoc expert who would like to take a look? (if not, let's just hit merge?)

@SethTisue SethTisue removed their assignment Jul 12, 2023
@som-snytt
Copy link
Contributor

Scala Center's charter should mandate that it have a Scaladoc expert on call 24/7. A Scaladoc doc.

@j-mie6 for future reference, if you at-notify someone in a commit message, they receive spam on every rebase. If your typo was intentional, thanks for that!

I will use that clever hack, @SethTissue! Maybe we can elicit further input from @oderski.

@j-mie6
Copy link
Contributor Author

j-mie6 commented Jul 12, 2023

Let's say that the typo was intentional. Didn't actually realise that a tag in a commit actually... Well... Tagged.

@som-snytt
Copy link
Contributor

In case I misremembered or github notifications have changed, I will alert you on my next PR and we will learn the truth. Certainly, mentioning a ticket will spam the comments on the issue. Also, if I remember to try that experiment, "Apologies in Advance"!

@j-mie6
Copy link
Contributor Author

j-mie6 commented Jul 12, 2023

Why is there no 😱 react GitHub...

Copy link
Contributor

@julienrf julienrf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@j-mie6 Thank you!

@julienrf julienrf merged commit 1413c3a into scala:main Jul 13, 2023
1 check passed
@j-mie6 j-mie6 deleted the ambiguous-link-guidance branch July 17, 2023 16:22
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

Successfully merging this pull request may close these issues.

4 participants