Skip to content
This repository has been archived by the owner on Dec 8, 2022. It is now read-only.

Fix typo on README #122

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

Fix typo on README #122

wants to merge 1 commit into from

Conversation

ranisalt
Copy link

I believe this to be a typo, private fields can't "be skipped" because they can't be used anyway, so that option would be useful public fields only.

@codecov
Copy link

codecov bot commented Oct 15, 2020

Codecov Report

Merging #122 (484bfcf) into master (b0be786) will decrease coverage by 1.34%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #122      +/-   ##
==========================================
- Coverage   93.65%   92.31%   -1.35%     
==========================================
  Files          11       11              
  Lines        1309     1080     -229     
==========================================
- Hits         1226      997     -229     
  Misses         45       45              
  Partials       38       38              
Impacted Files Coverage Δ
internet.go 76.69% <0.00%> (-5.53%) ⬇️
uuid.go 82.35% <0.00%> (-3.37%) ⬇️
datetime.go 97.46% <0.00%> (-0.80%) ⬇️
faker.go 90.53% <0.00%> (-0.79%) ⬇️
lorem.go 100.00% <0.00%> (ø)
phone.go 100.00% <0.00%> (ø)
price.go 100.00% <0.00%> (ø)
person.go 100.00% <0.00%> (ø)
address.go 100.00% <0.00%> (ø)
payment.go 100.00% <0.00%> (ø)
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b0be786...484bfcf. Read the comment docs.

Copy link
Owner

@bxcodec bxcodec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ranisalt thanks for the PR.
Added minor comment

@@ -90,7 +90,7 @@ Support Only For :
---

Unfortunately this library has some limitation
* It does not support private fields. Make sure your structs fields you intend to generate fake data for are public, it would otherwise trigger a panic. You can however omit fields using a tag skip `faker:"-"` on your private fields.
* It does not support private fields. Make sure your structs fields you intend to generate fake data for are public, it would otherwise trigger a panic. You can however omit fields using a tag skip `faker:"-"` on your public fields.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think both for private and public should be added the ignore tag faker:"-". I recommend removing this instead.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants