Skip to content

Improved documentation and slightly improved documentation generator …#315

Merged
bodiam merged 2 commits intomasterfrom
better_doc
Sep 1, 2022
Merged

Improved documentation and slightly improved documentation generator …#315
bodiam merged 2 commits intomasterfrom
better_doc

Conversation

@bodiam
Copy link
Copy Markdown
Contributor

@bodiam bodiam commented Aug 24, 2022

…to also generate descriptions.

@bodiam
Copy link
Copy Markdown
Contributor Author

bodiam commented Aug 24, 2022

@panilya I've now added the descriptions to the generator too. Thanks, that was quite easy after you created the generator, nice work!

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Aug 24, 2022

Codecov Report

Merging #315 (260223d) into master (d053424) will increase coverage by 0.05%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master     #315      +/-   ##
============================================
+ Coverage     94.88%   94.93%   +0.05%     
- Complexity     1927     1928       +1     
============================================
  Files           202      202              
  Lines          3853     3853              
  Branches        383      383              
============================================
+ Hits           3656     3658       +2     
+ Misses          100       99       -1     
+ Partials         97       96       -1     
Impacted Files Coverage Δ
src/main/java/net/datafaker/Battlefield1.java 100.00% <ø> (ø)
src/main/java/net/datafaker/CNPJ.java 100.00% <ø> (ø)
src/main/java/net/datafaker/Code.java 97.70% <ø> (ø)
src/main/java/net/datafaker/Community.java 100.00% <ø> (ø)
src/main/java/net/datafaker/Computer.java 100.00% <ø> (ø)
src/main/java/net/datafaker/Fallout.java 100.00% <ø> (ø)
src/main/java/net/datafaker/FinalSpace.java 100.00% <ø> (ø)
src/main/java/net/datafaker/GarmentSize.java 100.00% <ø> (ø)
src/main/java/net/datafaker/MassEffect.java 100.00% <ø> (ø)
src/main/java/net/datafaker/SoulKnight.java 100.00% <ø> (ø)
... and 3 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@bodiam bodiam requested a review from panilya August 24, 2022 12:28
Comment thread src/test/java/net/datafaker/script/ProvidersDocsGenerator.java
@snuyanzin
Copy link
Copy Markdown
Collaborator

I moved logic to Column enum and it makes it much easier to add new column
now in case there is a need then just add one line at eea3967#diff-829e8c91f3a1a76f619adccc4050e582f420b47530179dff7d50155d03928f19R126-R127
and a new column will be generated

also i left only one flush instead of flushing after each write

@bodiam
Copy link
Copy Markdown
Contributor Author

bodiam commented Sep 1, 2022

I moved logic to Column enum and it makes it much easier to add new column now in case there is a need then just add one line at eea3967#diff-829e8c91f3a1a76f619adccc4050e582f420b47530179dff7d50155d03928f19R126-R127 and a new column will be generated

also i left only one flush instead of flushing after each write

Thanks. I think there's a few other ways to improve it, but this could potentially be a good class for learning some solid coding or so in the future. Good news is that the code works well, no we only have to add 100s of descriptions to the fakers and the documentation will be even better.

@bodiam bodiam merged commit 6ffb8a3 into master Sep 1, 2022
@bodiam bodiam deleted the better_doc branch September 10, 2022 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants