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

docs(Forwarded): update note in forwarded.py #2151

Merged
merged 2 commits into from May 25, 2023
Merged

Conversation

john-g-g
Copy link
Contributor

@john-g-g john-g-g commented May 23, 2023

Summary of Changes

Simple one word change in source note about a field name

Related Issues

Please reference here any issue #'s that are relevant to this PR, or simply enter "N/A" if this PR does not relate to any existing issues.

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.

  • Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
  • Added tests for changed code.
  • Prefixed code comments with GitHub nick and an appropriate prefix.
  • Coding style is consistent with the rest of the framework.
  • Updated documentation for changed code.
    • Added docstrings for any new classes, functions, or modules.
    • Updated docstrings for any modifications to existing code.
    • Updated both WSGI and ASGI docs (where applicable).
    • Added references to new classes, functions, or modules to the relevant RST file under docs/.
    • Updated all relevant supporting documentation files under docs/.
    • A copyright notice is included at the top of any new modules (using your own name or the name of your organization).
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
  • Changes (and possible deprecations) have towncrier news fragments under docs/_newsfragments/, with the file name format {issue_number}.{fragment_type}.rst. (Run towncrier --draft to ensure it renders correctly.)

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

PR template inspired by the attrs project.

@codecov
Copy link

codecov bot commented May 23, 2023

Codecov Report

Merging #2151 (11de19d) into master (2543b27) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master     #2151   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           62        62           
  Lines         6789      6789           
  Branches      1095      1095           
=========================================
  Hits          6789      6789           
Impacted Files Coverage Δ
falcon/forwarded.py 100.00% <ø> (ø)

Copy link
Member

@CaselIT CaselIT left a comment

Choose a reason for hiding this comment

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

Thanks!

@CaselIT CaselIT requested review from vytas7 and kgriffs May 24, 2023 06:03
@vytas7 vytas7 changed the title Update note in forwarded.py docs: update note in forwarded.py May 25, 2023
@vytas7 vytas7 changed the title docs: update note in forwarded.py docs(Forwarded): update note in forwarded.py May 25, 2023
Copy link
Member

@vytas7 vytas7 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@vytas7 vytas7 merged commit 200a853 into falconry:master May 25, 2023
34 checks passed
@vytas7
Copy link
Member

vytas7 commented May 25, 2023

And thanks for this correction @john-g-g! Bonus points for the profile pic (presumably) featuring Conway's Game of Life 😅

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.

None yet

3 participants