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

Unify code examples with docs and screenshot #81

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

MartinKolarik
Copy link
Member

Both versions work, but the docs show --from and so does the screenshot at the top so it's confusing the commands then use the other variant.

@jimaek
Copy link
Member

jimaek commented Dec 8, 2023

It's on purpose to clarify that both work. I prefer keeping "from" as we use it everywhere and it matches Slack

@MartinKolarik
Copy link
Member Author

It hardly "qualifies" anything if it isn't explained anywhere. It just looks like typos. It's fine we support both for compatibility and we can even explicitly mention it somewhere if you want, but the -- version will still feel more familiar to most users so that's what we should promote here.

@jimaek
Copy link
Member

jimaek commented Dec 8, 2023

If you want to unify anything I would update the screenshot instead of texts. "from" works everywhere and is easier and faster to type. Or keep as is, which to me makes sense.

In the manual we have it documented I think that both work

@MartinKolarik
Copy link
Member Author

In the manual we have it documented I think that both work

We don't, the only place where it is like this are the three code examples. Again, let's add that as well if you want, but the default for CLI should be the -- version.

"from" works everywhere

That's not a good argument, different platforms have different ways of doing things, and people are used to them. Trying to have 100% consistency across them is counterproductive and even useless, as people using the CLI are generally not the same people using the Slack app.

@jimaek
Copy link
Member

jimaek commented Dec 8, 2023

The point is that you can copy a CLI command into Slack and it will work. That's why in the examples I wanted to avoid formal/strict rules like prefixing everything with --

Lets just document in this readme that from/--from are the same thing and thats it.

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