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

Similar feature was recently added to terraform-mode #4

Open
Fuco1 opened this issue Mar 3, 2023 · 2 comments
Open

Similar feature was recently added to terraform-mode #4

Fuco1 opened this issue Mar 3, 2023 · 2 comments

Comments

@Fuco1
Copy link

Fuco1 commented Mar 3, 2023

Hi @TxGVNN

We've recently added similar functionality to terraform-mode hcl-emacs/terraform-mode#19

Do you think there is some noticable difference between the two features? Would it make sense to enhance the built-in feature to achieve feature parity with your package? I see you have some functionality related to shr, showing the docs directly in Emacs. Does this work well?

M.

@TxGVNN
Copy link
Owner

TxGVNN commented Mar 4, 2023

Would it make sense to enhance the built-in feature to achieve feature parity with your package?

Yes, I think terraform-mode should provide a doc function by default. Even integrate this package into terraform-mode.

I see you have some functionality related to shr, showing the docs directly in Emacs. Does this work well?

I've just tested on my machine. You can do it by yourself.
Shr is used to render links. When click a link, they are md file so use markdown-mode to display.

terraform-doc

@jplindstrom
Copy link
Contributor

Personally I find it much nicer to display the docs inline in Emacs like terraform-doc does it rather than pop up a web page in my browser (which seems to regularly be on a different desktop).

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

No branches or pull requests

3 participants