Skip to content

[ deprecate ] README.Inspect#2928

Open
jamesmckinna wants to merge 3 commits intoagda:masterfrom
jamesmckinna:deprecate-README-Inspect
Open

[ deprecate ] README.Inspect#2928
jamesmckinna wants to merge 3 commits intoagda:masterfrom
jamesmckinna:deprecate-README-Inspect

Conversation

@jamesmckinna
Copy link
Collaborator

@jamesmckinna jamesmckinna commented Feb 4, 2026

See recent discussion on #1580 . No CHANGELOG.

--
-- Explaining how to use the inspect idiom and elaborating on the way
-- it is implemented in the standard library.
-- This module is DEPRECATED.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could we add a pointer towards the Agda documentation on the with idiom instead?

Copy link
Collaborator Author

@jamesmckinna jamesmckinna Feb 6, 2026

Choose a reason for hiding this comment

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

Yes. I'd been going to add that, as previously, to the deprecation section of Relation.Binary.PropositionalEquality.Core, but happy to do so here too.

But NB. the upstream change will only arise in v2.9.0, but AFAIK, there aren't readthedocs pages for that release... yet... so there's a more annoying synchronisation problem, by contrast with #2931 / #2932

UPDATED: latest commit makes a forward-in-time pointer to the v2.9.0, assuming we sort out a sensible v2.4 release schedule for which this makes sense...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Going back over #1930, I realised that I'd failed to push the claimed README.WithIn to explain the new syntax, on the model of the previous README.Inspect.

One thing to do might be to reinstate it as part of this PR, but I'd need to find it, and work out if it still makes sense against the new semantics!

Let me know whether you think this worthwhile before I push look for, never mind push, anything else!

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.

3 participants