docs: add hint that the generated data might be real ones

[ST-DDT]

We should warn our users that the generated data may be working ones and not the well known 555 dummy ones.

[codecov]

Codecov Report

Merging #959 (0b7b106) into main (045b8d6) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #959   +/-   ##
=======================================
  Coverage   99.64%   99.65%           
=======================================
  Files        2146     2146           
  Lines      230380   230380           
  Branches      977      981    +4     
=======================================
+ Hits       229563   229585   +22     
+ Misses        796      774   -22     
  Partials       21       21           

Impacted Files	Coverage Δ
src/modules/internet/user-agent.ts	92.75% <0.00%> (+6.37%)	⬆️

[Shinigami92]

Random thought: why not for:

• email
• iban
• vrm
• vim
• bitcoin address
• ipv4/6
• ...

I'm not sure if this hint is helpful 🤔

[ST-DDT]

We might want to add a general hint at some point (or maybe actually generate fake numbers).

But I created this one to address an issue raised in Discord:
https://discord.com/channels/929487054990110771/929544565348777984/974285076064002148

[Shinigami92]

We might want to add a general hint at some point (or maybe actually generate fake numbers).

But I created this one to address an issue raised in Discord: discord.com/channels/929487054990110771/929544565348777984/974285076064002148

IMO we should just add the hint now globally. For me it doesn't make really sense to add it here specifically just because one person asked in discord if values are real or not.
Some day just the next person would come up and ask for another function and so on 🤷
I also would say it is not in scope for Faker at all to generate or prevent real data. Just data that "looks" real and if they are "accidentally" real, so they are.

[pkuczynski]

I agree with @Shinigami92 that it should be done as a general hint and not for a specific function. The whole concept of faker is to generate data that looks real, so as he pointed out, they might be actually real!

[ST-DDT]

Yeah, I will think of a way to put it somewhere else.