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.

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

Update documentation reference to the default access logger #3783

Merged

Conversation

@Harmon758
Copy link
Contributor

commented May 21, 2019

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."

@Harmon758 Harmon758 requested review from asvetlov and webknjaz as code owners May 21, 2019

@asvetlov
Copy link
Member

left a comment

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

4 checks passed

Travis CI - Pull Request Build Passed
Details
WIP Ready for review
Details
codecov/patch Coverage not affected when comparing 4eecbcf...5e3bf5d
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
@asvetlov

This comment has been minimized.

Copy link
Member

commented May 21, 2019

Thanks!

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

(cherry picked from commit e54e7cc)

Co-authored-by: Harmon <Harmon758@gmail.com>

@Harmon758 Harmon758 deleted the Harmon758:accesslogger-reference-docs-update branch May 21, 2019

asvetlov added a commit that referenced this pull request May 21, 2019
[3.5] Update documentation reference to the default access logger (#3783
) (#3784)

(cherry picked from commit e54e7cc)

Co-authored-by: Harmon <Harmon758@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.