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

Make idris-info-mode derived from help-mode and #614

Merged
merged 1 commit into from
Feb 10, 2023

Conversation

keram
Copy link
Contributor

@keram keram commented Feb 1, 2023

reuse existing functionality from help-mode
for navigating through history and buffer handling.

Why:
To reduce maintanance cost of maintaining own implementation and to improve user experience by relying on
existing Emacs conventions.
For example provided key bindings l r q by default to navigate through buffer history or close the buffer.

Breaking changes

  • point does not move to the Idris info buffer when displaying Idris information (follows standard behaviour when invoking help commands like describe-function, describe-mode etc.)
  • command idris-info-quit does not anymore kill the info buffer. Instead it burries the buffer for later use and remove it's window or restore it's previous buffer (behaviour of quit-window)

reuse existing functionality from help-mode
for navigating through history and buffer handling.

Why:
To reduce maintanance cost of maintaining own implementation
and to improve user experience by relying on
existing Emacs conventions.
@keram keram force-pushed the main-idris-info-to-help-mode branch from be8f7d8 to 600c8f5 Compare February 2, 2023 00:12
@jfdm
Copy link
Contributor

jfdm commented Feb 8, 2023

Great work! Can we have the BREAKING changes documented in the CHANGELOG. It would be good if there was a high-level summary of the brilliant work you have been doing on the mode.

@jfdm jfdm merged commit 788f535 into idris-hackers:main Feb 10, 2023
@keram keram deleted the main-idris-info-to-help-mode branch March 18, 2023 13:53
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.

None yet

2 participants