Skip to content

Commit 12480bd

Browse files
authored
Merge pull request #84 from openedx/tcril/fix-gh-org-url
Fix github url strings (org edx -> openedx)
2 parents fb13058 + 0c0f146 commit 12480bd

File tree

13 files changed

+27
-129
lines changed

13 files changed

+27
-129
lines changed

.annotations_sample

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ coverage_target: 50.0
55
report_template_dir: code_annotations/report_templates/
66
rendered_report_dir: code_annotations/reports/
77
rendered_report_file_extension: .rst
8-
rendered_report_source_link_prefix: https://github.com/edx/edx-platform/tree/master/
8+
rendered_report_source_link_prefix: https://github.com/openedx/edx-platform/tree/master/
99
annotations:
1010
".. no_pii:":
1111
".. ignored:":

.github/workflows/commitlint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ on:
77

88
jobs:
99
commitlint:
10-
uses: edx/.github/.github/workflows/commitlint.yml@master
10+
uses: openedx/.github/.github/workflows/commitlint.yml@master

README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,16 @@ How To Contribute
3535

3636
Contributions are very welcome.
3737

38-
Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
38+
Please read `How To Contribute <https://github.com/openedx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
3939

4040
Even though they were written with ``edx-platform`` in mind, the guidelines
4141
should be followed for Open edX code in general.
4242

4343
PR description template should be automatically applied if you are sending PR from github interface; otherwise you
44-
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/edx/code-annotations/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_
44+
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/openedx/code-annotations/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_
4545

4646
Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you
47-
can find it at `ISSUE_TEMPLATE.md <https://github.com/edx/code-annotations/blob/master/.github/ISSUE_TEMPLATE.md>`_
47+
can find it at `ISSUE_TEMPLATE.md <https://github.com/openedx/code-annotations/blob/master/.github/ISSUE_TEMPLATE.md>`_
4848

4949
Reporting Security Issues
5050
-------------------------
@@ -64,8 +64,8 @@ refer to this `list of resources`_ if you need any assistance.
6464
:target: https://pypi.python.org/pypi/code-annotations/
6565
:alt: PyPI
6666

67-
.. |CI| image:: https://github.com/edx/code-annotations/workflows/Python%20CI/badge.svg?branch=master
68-
:target: https://github.com/edx/code-annotations/actions?query=workflow%3A%22Python+CI%22
67+
.. |CI| image:: https://github.com/openedx/code-annotations/workflows/Python%20CI/badge.svg?branch=master
68+
:target: https://github.com/openedx/code-annotations/actions?query=workflow%3A%22Python+CI%22
6969
:alt: CI
7070

7171
.. |codecov-badge| image:: http://codecov.io/github/edx/code-annotations/coverage.svg?branch=master
@@ -81,5 +81,5 @@ refer to this `list of resources`_ if you need any assistance.
8181
:alt: Supported Python versions
8282

8383
.. |license-badge| image:: https://img.shields.io/github/license/edx/code-annotations.svg
84-
:target: https://github.com/edx/code-annotations/blob/master/LICENSE.txt
84+
:target: https://github.com/openedx/code-annotations/blob/master/LICENSE.txt
8585
:alt: License

code_annotations/contrib/sphinx/extensions/featuretoggles.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class FeatureToggles(SphinxDirective):
3939
4040
- ``featuretoggles_repo_url``: Github repository where the code is hosted. E.g:
4141
42-
featuretoggles_repo_url = "https://github.com/edx/myrepo"
42+
featuretoggles_repo_url = "https://github.com/openedx/myrepo"
4343
4444
- ``featuretoggles_repo_version``: current version of the git repository. E.g:
4545

code_annotations/contrib/sphinx/extensions/settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class Settings(SphinxDirective):
3939
4040
- ``settings_repo_url``: Github repository where the code is hosted. E.g:
4141
42-
settings_repo_url = "https://github.com/edx/myrepo"
42+
settings_repo_url = "https://github.com/openedx/myrepo"
4343
4444
- ``settings_repo_version``: current version of the git repository. E.g:
4545

docs/contrib/how_to/add_new_annotations_and_extracted_docs.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Annotations are a great way to keep documentation close to the code, but also be
1313

1414
As an example, we have added `feature toggle annotations to the edx-platform codebase`_. A `Readthedocs document with the edx-platform feature toggles`_ has been generated from them.
1515

16-
.. _feature toggle annotations to the edx-platform codebase: https://github.com/edx/edx-platform/search?q=toggle_name
16+
.. _feature toggle annotations to the edx-platform codebase: https://github.com/openedx/edx-platform/search?q=toggle_name
1717
.. _Readthedocs document with the edx-platform feature toggles: https://edx.readthedocs.io/projects/edx-platform-technical/en/latest/featuretoggles.html
1818

1919
Add your own annotations and docs
@@ -27,7 +27,7 @@ The following steps need to be performed to document new types of annotations in
2727
* Add a new documentation page in the `edx-platform technical docs that will use this Sphinx extension`_. Adapt this step as needed for other services.
2828
* As required, add `custom linting for the new annotations to edx-lint`_. Again, follow the toggle and setting checkers as examples.
2929

30-
.. _new annotation format in code_annotations/contrib/config: https://github.com/edx/code-annotations/tree/master/code_annotations/contrib/config
31-
.. _Sphinx extension to collect these annotations: https://github.com/edx/code-annotations/tree/master/code_annotations/contrib/sphinx/extensions
32-
.. _edx-platform technical docs that will use this Sphinx extension: https://github.com/edx/edx-platform/tree/master/docs/technical
33-
.. _custom linting for the new annotations to edx-lint: https://github.com/edx/edx-lint/blob/master/edx_lint/pylint/annotations_check.py
30+
.. _new annotation format in code_annotations/contrib/config: https://github.com/openedx/code-annotations/tree/master/code_annotations/contrib/config
31+
.. _Sphinx extension to collect these annotations: https://github.com/openedx/code-annotations/tree/master/code_annotations/contrib/sphinx/extensions
32+
.. _edx-platform technical docs that will use this Sphinx extension: https://github.com/openedx/edx-platform/tree/master/docs/technical
33+
.. _custom linting for the new annotations to edx-lint: https://github.com/openedx/edx-lint/blob/master/edx_lint/pylint/annotations_check.py

docs/contrib/how_to/documenting_django_settings.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ There are a variety of tips in `certain sections of the how-to for documenting f
6161
Additional resources
6262
====================
6363

64-
The documentation format used to annotate non-boolean Django settings is also available from code-annotations repository: `setting_annotations.yaml <https://github.com/edx/code-annotations/blob/master/code_annotations/contrib/config/setting_annotations.yaml>`__.
64+
The documentation format used to annotate non-boolean Django settings is also available from code-annotations repository: `setting_annotations.yaml <https://github.com/openedx/code-annotations/blob/master/code_annotations/contrib/config/setting_annotations.yaml>`__.

docs/contrib/sphinx_extensions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ add the following to your ``conf.py``::
1515
featuretoggles_source_path = os.path.abspath(
1616
os.path.join(os.path.dirname(__file__), "..")
1717
)
18-
featuretoggles_repo_url = "https://github.com/edx/yourrepo"
18+
featuretoggles_repo_url = "https://github.com/openedx/yourrepo"
1919
try:
2020
featuretoggles_repo_version = git.Repo(search_parent_directories=True).head.object.hexsha
2121
except git.InvalidGitRepositoryError:

docs/decisions/0001-config-and-tools.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ The original usage of this generic tool was for annotating PII in the Open edX p
1515

1616
The new instances of annotation configs arose to support documenting Open edX feature toggles and non-toggle settings. Each of these will also have Sphinx extensions to support documentation. To start, the `feature toggles annotation config`_ was added to the ``edx-toggles`` repository, but there was no good home for the non-toggle settings annotation config, nor the documentation tools.
1717

18-
.. _PII annotations: https://github.com/edx/edx-cookiecutters/blob/7cf718093e7cca5c701a29fcbaa84660326b09ed/cookiecutter-django-app/%7B%7Bcookiecutter.repo_name%7D%7D/.pii_annotations.yml
19-
.. _feature toggles annotation config: https://github.com/edx/edx-toggles/blob/0986b10a806944fd4d00847501ff4f7e3904a2cb/feature_toggle_annotations.yaml
18+
.. _PII annotations: https://github.com/openedx/edx-cookiecutters/blob/7cf718093e7cca5c701a29fcbaa84660326b09ed/cookiecutter-django-app/%7B%7Bcookiecutter.repo_name%7D%7D/.pii_annotations.yml
19+
.. _feature toggles annotation config: https://github.com/openedx/edx-toggles/blob/0986b10a806944fd4d00847501ff4f7e3904a2cb/feature_toggle_annotations.yaml
2020

2121
Decision
2222
========

pylintrc

Lines changed: 4 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# ** DO NOT EDIT THIS FILE **
33
# ***************************
44
#
5-
# This file was generated by edx-lint: https://github.com/edx/edx-lint
5+
# This file was generated by edx-lint: https://github.com/openedx/edx-lint
66
#
77
# If you want to change this file, you have two choices, depending on whether
88
# you want to make a local change that applies only to this repo, or whether
@@ -28,7 +28,7 @@
2828
# CENTRAL CHANGE:
2929
#
3030
# 1. Edit the pylintrc file in the edx-lint repo at
31-
# https://github.com/edx/edx-lint/blob/master/edx_lint/files/pylintrc
31+
# https://github.com/openedx/edx-lint/blob/master/edx_lint/files/pylintrc
3232
#
3333
# 2. install the updated version of edx-lint (in edx-lint):
3434
#
@@ -64,7 +64,7 @@
6464
# SERIOUSLY.
6565
#
6666
# ------------------------------
67-
# Generated by edx-lint version: 5.2.1
67+
# Generated by edx-lint version: 5.2.5
6868
# ------------------------------
6969
[MASTER]
7070
ignore = ,migrations, settings, wsgi.py
@@ -102,54 +102,39 @@ enable =
102102
cell-var-from-loop,
103103
confusing-with-statement,
104104
continue-in-finally,
105-
cyclical-import,
106105
dangerous-default-value,
107-
dict-items-not-iterating,
108-
dict-keys-not-iterating,
109-
dict-values-not-iterating,
110106
duplicate-argument-name,
111107
duplicate-bases,
112108
duplicate-except,
113109
duplicate-key,
114-
eq-without-hash,
115-
exception-escape,
116-
exception-message-attribute,
117110
expression-not-assigned,
118-
filter-builtin-not-iterating,
119111
format-combined-specification,
120112
format-needs-mapping,
121113
function-redefined,
122114
global-variable-undefined,
123115
import-error,
124116
import-self,
125117
inconsistent-mro,
126-
indexing-exception,
127118
inherit-non-class,
128119
init-is-generator,
129120
invalid-all-object,
130-
invalid-encoded-data,
131121
invalid-format-index,
132122
invalid-length-returned,
133123
invalid-sequence-index,
134124
invalid-slice-index,
135125
invalid-slots-object,
136126
invalid-slots,
137-
invalid-str-codec,
138127
invalid-unary-operand-type,
139128
logging-too-few-args,
140129
logging-too-many-args,
141130
logging-unsupported-format,
142131
lost-exception,
143-
map-builtin-not-iterating,
144132
method-hidden,
145133
misplaced-bare-raise,
146134
misplaced-future,
147135
missing-format-argument-key,
148136
missing-format-attribute,
149137
missing-format-string-key,
150-
missing-super-argument,
151-
mixed-fomat-string,
152-
model-unicode-not-callable,
153138
no-member,
154139
no-method-argument,
155140
no-name-in-module,
@@ -158,44 +143,32 @@ enable =
158143
non-iterator-returned,
159144
non-parent-method-called,
160145
nonexistent-operator,
161-
nonimplemented-raised,
162-
nonstandard-exception,
163146
not-a-mapping,
164147
not-an-iterable,
165148
not-callable,
166149
not-context-manager,
167150
not-in-loop,
168151
pointless-statement,
169152
pointless-string-statement,
170-
property-on-old-class,
171153
raising-bad-type,
172154
raising-non-exception,
173-
raising-string,
174-
range-builtin-not-iterating,
175155
redefined-builtin,
176-
redefined-in-handler,
177156
redefined-outer-name,
178-
redefined-variable-type,
179157
redundant-keyword-arg,
180-
relative-import,
181158
repeated-keyword,
182159
return-arg-in-generator,
183160
return-in-init,
184161
return-outside-function,
185162
signature-differs,
186-
slots-on-old-class,
187163
super-init-not-called,
188164
super-method-not-called,
189-
super-on-old-class,
190165
syntax-error,
191-
sys-max-int,
192166
test-inherits-tests,
193167
too-few-format-args,
194168
too-many-format-args,
195169
too-many-function-args,
196170
translation-of-non-string,
197171
truncated-format-string,
198-
unbalance-tuple-unpacking,
199172
undefined-all-variable,
200173
undefined-loop-variable,
201174
undefined-variable,
@@ -211,11 +184,8 @@ enable =
211184
used-before-assignment,
212185
using-constant-test,
213186
yield-outside-function,
214-
zip-builtin-not-iterating,
215187

216188
astroid-error,
217-
django-not-available-placeholder,
218-
django-not-available,
219189
fatal,
220190
method-check-failed,
221191
parse-error,
@@ -237,7 +207,6 @@ enable =
237207
bad-classmethod-argument,
238208
bad-mcs-classmethod-argument,
239209
bad-mcs-method-argument,
240-
bad-whitespace,
241210
bare-except,
242211
broad-except,
243212
consider-iterating-dictionary,
@@ -247,16 +216,10 @@ enable =
247216
literal-used-as-attribute,
248217
logging-format-interpolation,
249218
logging-not-lazy,
250-
metaclass-assignment,
251-
model-has-unicode,
252-
model-missing-unicode,
253-
model-no-explicit-unicode,
254219
multiple-imports,
255220
multiple-statements,
256221
no-classmethod-decorator,
257222
no-staticmethod-decorator,
258-
old-raise-syntax,
259-
old-style-class,
260223
protected-access,
261224
redundant-unittest-assert,
262225
reimported,
@@ -284,7 +247,6 @@ enable =
284247
wrong-import-position,
285248

286249
missing-final-newline,
287-
mixed-indentation,
288250
mixed-line-endings,
289251
trailing-newlines,
290252
trailing-whitespace,
@@ -295,25 +257,7 @@ enable =
295257
deprecated-pragma,
296258
unrecognized-inline-option,
297259
useless-suppression,
298-
299-
cmp-method,
300-
coerce-method,
301-
delslice-method,
302-
dict-iter-method,
303-
dict-view-method,
304-
div-method,
305-
getslice-method,
306-
hex-method,
307-
idiv-method,
308-
next-method-called,
309-
next-method-defined,
310-
nonzero-method,
311-
oct-method,
312-
rdiv-method,
313-
setslice-method,
314-
using-cmp-argument,
315260
disable =
316-
bad-continuation,
317261
bad-indentation,
318262
consider-using-f-string,
319263
duplicate-code,
@@ -322,12 +266,7 @@ disable =
322266
global-statement,
323267
invalid-name,
324268
locally-disabled,
325-
locally-enabled,
326-
lowercase-l-suffix,
327-
misplaced-comparison-constant,
328269
no-else-return,
329-
no-init,
330-
no-self-use,
331270
suppressed-message,
332271
too-few-public-methods,
333272
too-many-ancestors,
@@ -346,54 +285,14 @@ disable =
346285
feature-toggle-needs-doc,
347286
illegal-waffle-usage,
348287

349-
apply-builtin,
350-
backtick,
351-
bad-python3-import,
352-
basestring-builtin,
353-
buffer-builtin,
354-
cmp-builtin,
355-
coerce-builtin,
356-
deprecated-itertools-function,
357-
deprecated-operator-function,
358-
deprecated-str-translate-call,
359-
deprecated-string-function,
360-
deprecated-sys-function,
361-
deprecated-types-field,
362-
deprecated-urllib-function,
363-
execfile-builtin,
364-
file-builtin,
365-
import-star-module-level,
366-
input-builtin,
367-
intern-builtin,
368-
long-builtin,
369-
long-suffix,
370-
no-absolute-import,
371-
non-ascii-bytes-literal,
372-
old-division,
373-
old-ne-operator,
374-
old-octal-literal,
375-
parameter-unpacking,
376-
print-statement,
377-
raw_input-builtin,
378-
reduce-builtin,
379-
reload-builtin,
380-
round-builtin,
381-
standarderror-builtin,
382-
unichr-builtin,
383-
unicode-builtin,
384-
unpacking-in-except,
385-
xrange-builtin,
386-
387288
logging-fstring-interpolation,,invalid-name,useless-object-inheritance,django-not-configured,consider-using-dict-items,consider-using-with
388289

389290
[REPORTS]
390291
output-format = text
391-
files-output = no
392292
reports = no
393293
score = no
394294

395295
[BASIC]
396-
bad-functions = map,filter,apply,input
397296
module-rgx = (([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
398297
const-rgx = (([A-Z_][A-Z0-9_]*)|(__.*__)|log|urlpatterns|logger|User)$
399298
class-rgx = [A-Z_][a-zA-Z0-9]+$
@@ -413,7 +312,6 @@ docstring-min-length = 5
413312
max-line-length = 120
414313
ignore-long-lines = ^\s*(# )?((<?https?://\S+>?)|(\.\. \w+: .*))$
415314
single-line-if-stmt = no
416-
no-space-check = trailing-comma,dict-separator
417315
max-module-lines = 1000
418316
indent-string = ' '
419317

@@ -484,4 +382,4 @@ int-import-graph =
484382
[EXCEPTIONS]
485383
overgeneral-exceptions = Exception
486384

487-
# 3fd87e519513f0a4e318643283ee1917ec197854
385+
# b74f2c15b5d64df07c4c2e83ccdb285a46f90e11

0 commit comments

Comments
 (0)