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

Clarify Emacs installation instructions #985

Merged
merged 1 commit into from Oct 14, 2019

Conversation

@sswistun-vl
Copy link
Collaborator

sswistun-vl commented Oct 11, 2019

Corrected errors in installation tutorial

@tgodzik

This comment has been minimized.

Copy link
Collaborator

tgodzik commented Oct 11, 2019

I asked on gitter and @kschwarz1116 suggested:

maybe it makes more sense to provide a link to the MELPA website and describe what to install using it, instead of adding it to the .emacs changes? https://melpa.org/#/getting-started If I were new to emacs and getting started, I think that would be more helpful than just getting a block of code to put somewhere on my machine.

I think we can keep the code but let people know about the getting started guide.

@olafurpg

This comment has been minimized.

Copy link
Member

olafurpg commented Oct 13, 2019

cc/ @JesusMtnez could you take a look?

@olafurpg olafurpg changed the title Emacs tutorial Clarify Emacs installation instructions Oct 13, 2019
@JesusMtnez

This comment has been minimized.

Copy link
Contributor

JesusMtnez commented Oct 14, 2019

Current Emacs instructions, with the fixes suggested in this PR, not only suggest how to install metals support for Emacs, but also suggests to use package.el package manager and use-package helper. But they are not the only options to manage your Emacs packages.

Other packages documentations usually offer how to configure it using just plain package.el(example), without use-package. Usually, they add more documentation to include helpers like use-package, straight.el, el-get,...

What they don't usually do is provide the package.el configuration to add melpa or melpa-stable repositories, they just indicate the package is available through melpa if you want to use it.

So, this changes are necessary to fix package.el setup, but maybe we could improve our documentation to avoid forcing users to understand package.el and use-package.

@sswistun-vl

This comment has been minimized.

Copy link
Collaborator Author

sswistun-vl commented Oct 14, 2019

Main purpose of this PR was to correct tutorial that didn't work for me. In my opinion it's far more important to make it work than to educate someone, but feel free to correct that as I don't have knowledge about Emacs to do it informatively.

@JesusMtnez

This comment has been minimized.

Copy link
Contributor

JesusMtnez commented Oct 14, 2019

IMHO, merging this PR does no harm to the documentation, as @sswistun-vl said, it will fix to make it possible to copy/paste and go. But we may consider to update this configuration documentation to be more complete about how to configure metals for Emacs in the future, in another PR of course.

@tgodzik tgodzik merged commit b2f2adf into scalameta:master Oct 14, 2019
2 checks passed
2 checks passed
build
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@olafurpg

This comment has been minimized.

Copy link
Member

olafurpg commented Oct 15, 2019

Main purpose of this PR was to correct tutorial that didn't work for me. In my opinion it's far more important to make it work than to educate someone

@sswistun-vl I encourage you to formulate your arguments more carefully in the future. @JesusMtnez did not argue in favor of the opposite point even if you implicitly hint that he thinks it's more important to educate someone than to make it work. This debate style is not tolerated when contributing to any Scalameta projects.

@JesusMtnez

This comment has been minimized.

Copy link
Contributor

JesusMtnez commented Oct 15, 2019

Just to clarify, I was not trying to say we should educate about how to configure/use Emacs. On the contrary, what I was trying to say was that the current configuration is not offering a way to configure metals using Emacs vanilla with its default package manager, but instead, it is forcing the user to understand use-package, which is not a requirement to use metals at all.

That is why I proposed to change or add to this documentation the process to install, configure and use metals with Emacs vanilla, at least. That way, anyone using other package managers or helpers could adapt it easily if they want to.

@sswistun-vl Sorry if I did not express myself correctly 😄 but I was not trying to force my opinion here at all.

@sswistun-vl

This comment has been minimized.

Copy link
Collaborator Author

sswistun-vl commented Oct 16, 2019

Me neither, I was just saying that we should present working configuration first and then show how to create custom one - that way both fresh and seasoned Emacs users can easily benefit from it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.