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

Remove Either documentation page #4400

Merged

Conversation

reardonj
Copy link
Contributor

Resolves #4392

  • Remove Either documentation page
  • Update FAQ section and links referring to page
  • Put StateT documentation in the right order

docs/faq.md Outdated
Comment on lines 40 to 42
This syntax and the type class instances for `Either` can be imported using `cats.syntax._`, which will also bring in syntactic enrichment and instances for other standard library types, or you can import only the `Either` enrichment with `cats.syntax.either._`.

There are a few minor mismatches between `Xor` and `Either`. For example, in some cases you may need to specify a type parameter for an enrichment method on `Either` (such as `leftMap`) even though it was properly inferred for `Xor`. See the [`Either` section of this guide](datatypes/either.md#either-in-the-small-either-in-the-large) for more information about these issues.
There are a few minor mismatches between `Xor` and `Either`. For example, in some cases you may need to specify a type parameter for an enrichment method on `Either` (such as `leftMap`) even though it was properly inferred for `Xor`, due `Either` having covariant type parameters.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated this, but is this still an FAQ two major versions later?

@armanbilge armanbilge changed the title Remove Either documentation page. Remove Either documentation page. Jun 26, 2023
@reardonj reardonj force-pushed the remove-obsolete-either-documentation branch from cbd8e65 to a2408ba Compare June 28, 2023 00:31
@reardonj reardonj requested a review from armanbilge June 28, 2023 00:33
docs/faq.md Outdated Show resolved Hide resolved
@armanbilge
Copy link
Member

Sorry, one final thought: instead of completely 404ing the page can we put something there to redirect inbound links somewhere more useful?

@reardonj
Copy link
Contributor Author

Sorry, one final thought: instead of completely 404ing the page can we put something there to redirect inbound links somewhere more useful?

I perused the Laika documentation, but I don't see a way to have a page exist without it showing up in the table of contents. Is there something in the Typelevel site setup to allow such a redirect?

@armanbilge
Copy link
Member

but I don't see a way to have a page exist without it showing up in the table of contents.

Jens on Discord:

it's laika.excludeFromNavigation = true in the config header of md files

Not sure if that's supported in Laika 0.18.x, if not I might need to get the sbt-typelevel upgrade PR in first.

Copy link
Member

@armanbilge armanbilge left a comment

Choose a reason for hiding this comment

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

Thank you!

Copy link
Member

@danicheg danicheg left a comment

Choose a reason for hiding this comment

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

🚀

@danicheg danicheg changed the title Remove Either documentation page. Remove Either documentation page Jul 9, 2023
@danicheg danicheg merged commit fa32a6b into typelevel:main Jul 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove Obsolete Either Documentation
3 participants