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: Various cleanup of outdated comments and docstrings #31754

Merged
merged 1 commit into from Feb 14, 2023

Conversation

timmc-edx
Copy link
Contributor

  • Remove pylint warning suppression from SHAKE-128 hexdigest calls; these are no longer needed as of astroid 2.12.12. For background, see issue Pylint doesn't know that hashlib's SHAKE hashers take a positional argument in their hexdigest pylint-dev/pylint#4039. Also, correct a comment that referred to SHAKE-256 instead of SHAKE-128.
  • Replace "released" with "beta" in several places where there was a copy & paste error in dark_lang. Add mention of beta_lang to a docstring where it was omitted.
  • Remove comment regarding Mongo startup; the code it referred to has since been removed.
  • Fix typos.

- Remove pylint warning suppression from SHAKE-128 hexdigest calls; these
  are no longer needed as of astroid 2.12.12. For background, see issue
  <pylint-dev/pylint#4039>. Also, correct a comment
  that referred to SHAKE-256 instead of SHAKE-128.
- Replace "released" with "beta" in several places where there was a copy
  & paste error in dark_lang. Add mention of `beta_lang` to a docstring
  where it was omitted.
- Remove comment regarding Mongo startup; the code it referred to has since
  been removed.
- Fix typos.
@@ -123,7 +123,7 @@ def _fuzzy_match(self, lang_code):

def _clean_accept_headers(self, request):
"""
Remove any language that is not either in ``self.released_langs`` or
Remove any language that is not either in ``self.released_langs`` or ``self.beta_langs`` (if enabled) or
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Author's note: See the implementation of _fuzzy_match a few lines above.

@timmc-edx timmc-edx merged commit 197fef9 into master Feb 14, 2023
@timmc-edx timmc-edx deleted the timmc/various branch February 14, 2023 18:12
@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

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