MrPowers / quinn

pyspark methods to enhance developer productivity 📣 👯 🎉
https://mrpowers.github.io/quinn/
Apache License 2.0
597 stars 93 forks source link

DOC: Structural inconsistency of quinn examples in the README documentation #213

Closed kunaljubce closed 4 months ago

kunaljubce commented 4 months ago

Quinn version checks

Location of the documentation

README.md file

Documentation problem

We have a structural inconsistency in the quinn README examples. In some examples, it is of the format:

Function Name 
     |
Example
     |
Description

And in some other examples, the format is:

Function Name 
     |
Description
     |
Example

image (1)

Suggested fix for documentation

From a new user point of view, the latter seems easier to follow, i.e.

Function Name 
     |
Description
     |
Example

Please create a PR to change all examples on README.md to fit this format.

SemyonSinchenko commented 4 months ago

@kunaljubce May I assign it to you?

kunaljubce commented 4 months ago

@SemyonSinchenko Wanted to label this a good first issue. I can take it up, no issues with that btw!