Skip to content

Fix typos in bin/ docstrings and a stray character that breaks fork_counter.py - #16

Open
Avicennasis wants to merge 1 commit into
splunk:masterfrom
Avicennasis:docs/fix-typos
Open

Fix typos in bin/ docstrings and a stray character that breaks fork_counter.py#16
Avicennasis wants to merge 1 commit into
splunk:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fixes 3 typos in bin/. Each string was verified against live master content before editing.

  • bin/fork_counter.py: Y# Copyright 2011 Splunk, Inc. -> # Copyright 2011 Splunk, Inc.
  • bin/splunkgit_settings.py: Functions for retriveing settigs from splunkgit conf file. -> Functions for retrieving settings from splunkgit conf file.
  • bin/fetch_github_data.py: This script polls usefull github data from github -> This script polls useful github data from github

Please review carefully - the first one is a real bug, not a typo

bin/fork_counter.py currently starts with a stray Y before the copyright comment. Python parses that line as the expression statement Y followed by a comment, so the file compiles but raises NameError: name 'Y' is not defined as soon as it is imported:

$ python bin/fork_counter.py
Traceback (most recent call last):
  File "bin/fork_counter.py", line 1, in <module>
    Y# Copyright 2011 Splunk, Inc.
NameError: name 'Y' is not defined

Removing the stray character makes the module importable again. Nothing else in the repo currently references fork_counter / ForkCounter, so this change cannot regress any existing caller.

The other two changes are docstring-only.

Deliberately not changed

  • Everything under lib/joblib/ - that is a vendored copy of the upstream joblib library (it ships its own test suite and module docs). 13 of the reported typos live there and belong upstream, not in this repo.
  • GithubAPI._link_header_value_for_reletion - the misspelling is a method name, and renaming an identifier is out of scope for a typo PR.

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.

1 participant