Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation reference to the default access logger #3783

Merged
merged 3 commits into from
May 21, 2019
Merged

Update documentation reference to the default access logger #3783

merged 3 commits into from
May 21, 2019

Conversation

Harmon758
Copy link
Member

@Harmon758 Harmon758 commented May 21, 2019 •
edited
Loading

What do these changes do?

Update the documentation to reflect the proper path to AccessLogger, which has been aiohttp.web_log.AccessLogger instead of aiohttp.helpers.AccessLogger since 9483209.

Are there changes in behavior for the user?

No

Related issue number

N/A

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

asvetlov
asvetlov requested changes May 21, 2019
View reviewed changes
Copy link
Member

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

I would say that AccessLogger is not exposed as aiohttp.web namespace.
Thus it is a private class and should not be mentioned at all in docs.

docs/logging.rst Outdated Show resolved Hide resolved
@Harmon758 Harmon758 changed the title Update documentation reference to AccessLogger Update documentation reference to the default access logger May 21, 2019
@asvetlov asvetlov merged commit e54e7cc into aio-libs:master May 21, 2019
@asvetlov
Copy link
Member

Thanks!

asvetlov pushed a commit that referenced this pull request May 21, 2019
@Harmon758 @asvetlov
[3.5] Update documentation reference to the default access logger (#3783
602df4d 
)

(cherry picked from commit e54e7cc)

Co-authored-by: Harmon <[email protected]>
@Harmon758 Harmon758 deleted the accesslogger-reference-docs-update branch May 21, 2019 08:56
asvetlov added a commit that referenced this pull request May 21, 2019
@asvetlov @Harmon758
[3.5] Update documentation reference to the default access logger (#3783
9106e93 
) (#3784)

(cherry picked from commit e54e7cc)

Co-authored-by: Harmon <[email protected]>
@lock lock bot added the outdated label May 20, 2020
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label May 20, 2020
@lock lock bot locked as resolved and limited conversation to collaborators May 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@asvetlov asvetlov asvetlov approved these changes

@webknjaz webknjaz Awaiting requested review from webknjaz webknjaz is a code owner

Assignees
No one assigned
Labels
bot:chronographer:provided There is a change note present in this PR outdated
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Harmon758 @asvetlov