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

Fix reveal.js capitalization and remove Asciidoctor in the package.json description #278

Merged
merged 1 commit into from
Dec 4, 2019

Conversation

ggrossetie
Copy link
Member

No description provided.

The npm package only works with Asciidoctor.js
@obilodeau obilodeau merged commit 07ed812 into asciidoctor:master Dec 4, 2019
@mojavelinux
Copy link
Member

Doesn't the converter still work with Asciidoctor Ruby? Removing Asciidoctor seems to indicate it only works with Asciidoctor.js.

@ggrossetie
Copy link
Member Author

I removed it from the package.json, Asciidoctor is still mentioned in the Gem description/summary. The node package only works with Asciidoctor.js and in my opinion it's confusing to say that the converter is for Asciidoctor and Asciidoctor.js when in fact you can't use the Node package with Asciidoctor Ruby.

If we talk about the "project" then we should not mention the implementation and say "A reveal.js converter for Asciidoctor".
In this case, we expect the user to understand that since it's a Node package it's going to work with the JavaScript implementation of Asciidoctor (implicit).

On the project page it makes sense to say that the converter works for both Asciidoctor and Asciidoctor.js (we could also add that it works with AsciidoctorJ) but on the packages (jar, gem, npm...) I think we should not talk about the other implementations.

@mojavelinux
Copy link
Member

That makes total sense. 🤦‍♂️

@obilodeau
Copy link
Member

I removed it from the package.json, Asciidoctor is still mentioned in the Gem description/summary. The node package only works with Asciidoctor.js and in my opinion it's confusing to say that the converter is for Asciidoctor and Asciidoctor.js when in fact you can't use the Node package with Asciidoctor Ruby.

If we talk about the "project" then we should not mention the implementation and say "A reveal.js converter for Asciidoctor".
In this case, we expect the user to understand that since it's a Node package it's going to work with the JavaScript implementation of Asciidoctor (implicit).

On the project page it makes sense to say that the converter works for both Asciidoctor and Asciidoctor.js (we could also add that it works with AsciidoctorJ) but on the packages (jar, gem, npm...) I think we should not talk about the other implementations.

Very good points. I'll try to remember that nuance. Feel free to correct me if I mix things up in the future.

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.

3 participants