improve address descriptions

[brianvoe]

@se-omarayman Ok i just realized i forgot to say something about these descriptions. I think one of the things i was trying to stay away from the repeating certain parts. I was trying to see if we could go more the route of not including generate or random in the sentence as they are already givens

Example: Set of fields including street, city, state, zip code, country, latitude, and longitude Name of a city Full name of a country

Let me know if that makes sense or if you disagree

[se-omar]

Hmm, i think i agree. having the full sentence "generates a random full name" is more of a complete and coherent sentence than "full name" but most of it is useless info. if I'm using the library i want to quickly see what random X does it generate so i only care about the X

[se-omar]

but looking at a faker-js sample and a faker-python sample they use some form of "Generate a random X" for a more coherent sentence i guess

[brianvoe]

I updated animal to give you an idea of what i was thinking https://github.com/brianvoe/gofakeit/blob/develop/animal.go

[brianvoe]

I agree if the description is something like "Pet name" adding "Generate random pet name" fills out the sentence more but i threw this into chatgpt to help and i was able to get some better wording outputs. so for pet name it gave me. "A petname is a special, affectionate nickname given to someone you care about deeply." I took that and simplified it to "Affectionate nickname given to a pet"

[brianvoe]

"Affectionate nickname given to a pet" > "Generate random pet name"

[se-omar]

so i guess if I'm using the library like gofakeit.CarMaker() , there is no need to say in the description that it generates a car maker, but it's better to describe any special cases the function has or what a car maker is. so the description for car maker is "A large industrial facility with assembly lines for producing cars".

check the updated descriptions for Car and let me know

[brianvoe]

I think you see my thoughts on this pretty well. I wish i had the answers for each scenario. Let me try to do car maker and see what you think.

Prompt: i need a description of the definition of "car maker" (with previous prompts saying no more than 15 words) Output: A car maker is a company that designs, manufactures, and sells automobiles. Adjustment: Company name that designs, manufactures, and sells automobiles

[brianvoe]

I think your descriptions of cars is pretty good. the feedback for those would be trying to make is short and sweet. I try to do less than 10 but its its not enough no more than 15, start sentences with capital letter and I try not to start it the A. Let me know your thoughts.

I think with all that the descriptions will look so good within those parameters.

[se-omar]

I see, I'll finish up another category with these parameters and link it here for review

[se-omar]

https://github.com/se-omarayman/gofakeit/blob/car-descriptions/car.go i think these should work.

so I will go with "short description clarifying what the entity is" for the rest of the descriptions.

[brianvoe]

Perfect! Those look so good! I cant wait to see the rest of them. Nice job!

[brianvoe]

When you do a pr just make sure to set it to develop. sometimes i forget and it gets merged into master. there might be a setting i can set to automatically do that