Skip to content

2.x Add a Users Guide#2167

Merged
acobster merged 5 commits into2.x-docs-apifrom
2.x-users-guide
Jan 17, 2020
Merged

2.x Add a Users Guide#2167
acobster merged 5 commits into2.x-docs-apifrom
2.x-users-guide

Conversation

@gchtr
Copy link
Copy Markdown
Member

@gchtr gchtr commented Jan 12, 2020

Ticket: #2160 (comment)

Issue

We already have new guides for Posts and Terms in #2073. We should have one for Users as well.

Solution

Add Users Guide and clarify working with User Class Maps.

Impact

None.

Usage Changes

None.

Considerations

None?

Testing

None needed.

@gchtr gchtr added the 2.0 label Jan 12, 2020
@gchtr gchtr requested a review from acobster January 12, 2020 12:21
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 12, 2020

Codecov Report

Merging #2167 into 2.x-docs-api will increase coverage by 0.31%.
The diff coverage is n/a.

Impacted file tree graph

@@                Coverage Diff                 @@
##             2.x-docs-api    #2167      +/-   ##
==================================================
+ Coverage           95.72%   96.03%   +0.31%     
- Complexity           1539     1576      +37     
==================================================
  Files                  50       50              
  Lines                3949     4063     +114     
==================================================
+ Hits                 3780     3902     +122     
+ Misses                169      161       -8
Impacted Files Coverage Δ Complexity Δ
lib/Post.php 97.81% <0%> (-0.2%) 230% <0%> (+32%)
lib/Twig.php 98.94% <0%> (+0.02%) 53% <0%> (ø) ⬇️
lib/Admin.php 96.15% <0%> (+0.15%) 11% <0%> (ø) ⬇️
lib/DateTimeHelper.php 90.62% <0%> (+3.12%) 20% <0%> (+5%) ⬆️
lib/Timber.php 95.72% <0%> (+9.76%) 32% <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 70a1b5b...e11566b. Read the comment docs.

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.

Both of these read great to me. The rundown on Class Maps really helps make everything click with the big benefits to the API changes. The only pending Q is on whether null or false is the correct return over on #2160. Pending the outcome of that, this should match

update documented return value from `null` to `false`

Co-Authored-By: Jared Novack <jarednova@upstatement.com>
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.

Awesome. Thanks again @gchtr !

@acobster
Copy link
Copy Markdown
Collaborator

@jarednova I committed your suggestions, merging this in now.

@acobster acobster merged commit 0cd1c2a into 2.x-docs-api Jan 17, 2020
@jarednova jarednova deleted the 2.x-users-guide branch January 17, 2020 23:03
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