falconry / falcon

The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.
https://falcon.readthedocs.io/en/stable/
Apache License 2.0
9.53k stars 945 forks source link

Clarify CORS options in code example (resolves #1930) #1933

Closed forana closed 3 years ago

forana commented 3 years ago

Summary of Changes

This PR modified the comments in the CORS code to make it clearer that the two options are alternatives.

Related Issues

Fixes #1930

forana commented 3 years ago

The test failures here don't seem to be related to this change... ModuleNotFoundError: No module named 'mimeparse'

vytas7 commented 3 years ago

Indeed, I've already fixed that as part of https://github.com/falconry/falcon/pull/1922, but the PR itself has to stay in Draft for a while now, so I carved out that as a separate PR in order to unblock the CI: https://github.com/falconry/falcon/pull/1935.

codecov[bot] commented 3 years ago

Codecov Report

Merging #1933 (c43745d) into master (d26a476) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master     #1933   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           63        63           
  Lines         6610      6610           
  Branches      1067      1067           
=========================================
  Hits          6610      6610           

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 d26a476...c43745d. Read the comment docs.