Skip to content

Improve docs: why do we ignore almost all the FP jargon in this project #451

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

Open
3 tasks
sobolevn opened this issue Jul 7, 2020 · 16 comments
Open
3 tasks
Labels
documentation enhancement New feature or request

Comments

@sobolevn
Copy link
Member

sobolevn commented Jul 7, 2020

@sobolevn sobolevn added enhancement New feature or request documentation labels Jul 7, 2020
@thepabloaguilar
Copy link
Member

Can FP users understand what is "a thing" without jargon? Can they correlate "a thing" to a jargon?
If the answers to these questions are "yes" I think we can "ignore" the FP jargon to be more inclusive with people that do not understand it!

On the other hand, we have to get these people familiar with FP jargon to understand what they are using.

@thepabloaguilar
Copy link
Member

What's the final decision here? Will we get out of FP jargons?

@sobolevn
Copy link
Member Author

sobolevn commented Jul 28, 2020

Yes, we don't use it. (As a matter of fact).

The history behind this is really interesting. The first name of this project was dry-monads: https://github.com/dry-python/returns/tree/0.1.0

But, then I got a lot of uneducated feedback. It was hard to manage. So, instead we went to make this concept hidden.
And it worked!

Basically, we came up with our own terms that do mean the similar things. And we should stick to them.

@thepabloaguilar
Copy link
Member

So, the first item was completed I guess.

  • Describe our decision

Answer:

then I got a lot of uneducated feedback. It was hard to manage. So, instead we went to make this concept hidden.
And it worked!
Basically, we came up with our own terms that do mean the similar things. And we should stick to them.


Where we have to add the link? On the first page?

What exactly we have to improve?

@sobolevn
Copy link
Member Author

What exactly we have to improve?

There are a lot of concepts that are poorly illustrated in the original article: https://github.com/jmesyou/functional-programming-jargon.py

I guess we can improve almost every point in there 🙂

@thepabloaguilar
Copy link
Member

What about we bring this article to a repository inside dry-python, creating a new one or forking??
functional-programming-jargon.py seems like just a copy-paste "parsing" the code from JS to Python without worried about if it's the correct way to explain using Python!

@thepabloaguilar
Copy link
Member

If we create a repository inside dry-python it's easier to update it, you've opened a PR there 23 days ago and so far you haven't got any response!

@sobolevn
Copy link
Member Author

Great idea!

@sobolevn
Copy link
Member Author

sobolevn commented Aug 5, 2020

New repo: https://github.com/dry-python/functional-jargon-python

@thepabloaguilar
Copy link
Member

How do you want to do this??
Maybe copy-paste the structure from https://github.com/jmesyou/functional-programming-jargon.py without the content of each topic and we can progressively be adding the content by ourselves?

@sobolevn
Copy link
Member Author

sobolevn commented Aug 5, 2020

Sounds like a plan 👍

@thepabloaguilar
Copy link
Member

Can you initialize the repo, please? Because I can't fork if it's empty 😞

@thepabloaguilar
Copy link
Member

Just a simple README or a LICENSE hahaha

@sobolevn
Copy link
Member Author

sobolevn commented Aug 6, 2020

@thepabloaguilar you can use the original repo, don't need to fork it. Do you have the right permissions?

@thepabloaguilar
Copy link
Member

Done, I've pushed the content!!
I decide to keep some texts just to help in some way, but every topic is marked as TODO
Now we can start filling the gaps hahaha

@sobolevn
Copy link
Member Author

sobolevn commented Aug 7, 2020

Awesome! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Development

No branches or pull requests

2 participants