Skip to content

2.x User factories DocBlocks#2168

Merged
acobster merged 4 commits into2.x-user-factoriesfrom
2.x-user-factories-docs
Jan 17, 2020
Merged

2.x User factories DocBlocks#2168
acobster merged 4 commits into2.x-user-factoriesfrom
2.x-user-factories-docs

Conversation

@gchtr
Copy link
Copy Markdown
Member

@gchtr gchtr commented Jan 12, 2020

Ticket: #2160

This pull request improves the DocBlocks for the new User API and the User Class Map, so that they will properly appear in the online documentation.

@gchtr gchtr added the 2.0 label Jan 12, 2020
@gchtr gchtr requested a review from acobster January 12, 2020 12:54
@gchtr gchtr requested a review from pascalknecht as a code owner January 12, 2020 12:54
Copy link
Copy Markdown
Member

@jarednova jarednova left a comment

Choose a reason for hiding this comment

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

Looks good @gchtr! I'll leave it to @acobster if he wants to take pass or merge ahead into 2.x-user-factories where it can be tracked with that PR

* Gets one or more users as an array.
*
* By default, Timber will use the `Timber\User` class to create a your post objects. To
* control which class is used for your post objects, use [Class Maps]().
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is the one thing I was like, "oh, we should remember to make a guide/link for that" and then I saw you were one step ahead of me with yr @todo

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 12, 2020

Codecov Report

❗ No coverage uploaded for pull request base (2.x-user-factories@629e71b). Click here to learn what that means.
The diff coverage is 100%.

Impacted file tree graph

@@                  Coverage Diff                  @@
##             2.x-user-factories    #2168   +/-   ##
=====================================================
  Coverage                      ?   94.25%           
  Complexity                    ?     1607           
=====================================================
  Files                         ?       53           
  Lines                         ?     4094           
  Branches                      ?        0           
=====================================================
  Hits                          ?     3859           
  Misses                        ?      235           
  Partials                      ?        0
Impacted Files Coverage Δ Complexity Δ
lib/Timber.php 83.33% <100%> (ø) 39 <0> (?)
lib/Factory/CommentFactory.php 97.43% <100%> (ø) 20 <0> (?)
lib/Factory/UserFactory.php 96.96% <100%> (ø) 19 <0> (?)

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 629e71b...0a959b7. Read the comment docs.

Copy link
Copy Markdown
Collaborator

@acobster acobster left a comment

Choose a reason for hiding this comment

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

These look great. Thanks!

@acobster acobster merged commit 0d8b472 into 2.x-user-factories Jan 17, 2020
@gchtr gchtr deleted the 2.x-user-factories-docs branch April 26, 2020 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants