Summary

[WIP] Code and Documentation Linking

Review Request #9401 — Created Nov. 26, 2017 and discarded Feb. 10, 2019, 9:16 a.m.

Information

Owner

slamo

Repository

Review Board

Branch

master

Bugs

Depends On

Reviewers

Groups

reviewboard, students

People

Description


Create template tags for wrapping code references
Added CodeInspectorInfoboxView with dummy URL.
Configured DiffReviewableView to manage/create CodeInspectorInfoboxViews
Code Inspector Infobox mockup using temporary API.
Implement CodeInspector base classes
Implement Pygments Lexer code inspector

Testing Done

Issues

Description	From	Last Updated
E128 continuation line under-indented for visual indent	reviewbot	Nov. 26, 2017, 6:47 p.m.
E126 continuation line over-indented for hanging indent	reviewbot	Nov. 26, 2017, 6:47 p.m.
E126 continuation line over-indented for hanging indent	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Nov. 26, 2017, 6:47 p.m.
E501 line too long (109 > 79 characters)	reviewbot	Nov. 26, 2017, 6:47 p.m.
E265 block comment should start with '# '	reviewbot	Nov. 26, 2017, 6:47 p.m.
New files should include module docstrings at the top (like """Base for code inspector backends""")	giuliacm	Dec. 5, 2017, 11:31 p.m.
W391 blank line at end of file	reviewbot	Dec. 3, 2017, 8:52 a.m.
Module docstring for new file.	giuliacm	Dec. 5, 2017, 11:31 p.m.
Class docstring.	giuliacm	Dec. 5, 2017, 11:31 p.m.
Module docstring for new file.	giuliacm	Dec. 5, 2017, 11:31 p.m.
Class docstring.	giuliacm	Dec. 5, 2017, 11:31 p.m.
E126 continuation line over-indented for hanging indent	reviewbot	Dec. 3, 2017, 8:52 a.m.
E126 continuation line over-indented for hanging indent	reviewbot	Dec. 3, 2017, 8:52 a.m.
Module docstring for new file.	giuliacm	Dec. 5, 2017, 11:31 p.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Dec. 3, 2017, 8:52 a.m.
F401 'traceback' imported but unused	reviewbot	Dec. 3, 2017, 8:52 a.m.
F401 'reviewboard.codeinspector.pygments_lexer_code_inspector_backend.PygmentsLexerCodeInspectorBackend' imported but unused	reviewbot	Dec. 3, 2017, 8:52 a.m.
E501 line too long (109 > 79 characters)	reviewbot	Dec. 3, 2017, 8:52 a.m.
E501 line too long (85 > 79 characters)	reviewbot	Dec. 3, 2017, 8:52 a.m.
E702 multiple statements on one line (semicolon)	reviewbot	Dec. 3, 2017, 8:52 a.m.
E501 line too long (88 > 79 characters)	reviewbot	Dec. 3, 2017, 8:52 a.m.
Module dosctring for new file.	giuliacm	Dec. 5, 2017, 11:31 p.m.
Don't need a space here.	giuliacm	Dec. 5, 2017, 11:31 p.m.
This should be alphabetically sorted with the other imports.	giuliacm	Dec. 5, 2017, 11:31 p.m.
E265 block comment should start with '# '	reviewbot	Dec. 3, 2017, 8:52 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/codeinspector/code_inspector_backends.py (Diff revision 1)
An issue was opened. Show all issues
```
E128 continuation line under-indented for visual indent
```
reviewboard/codeinspector/pygments_lexer_code_inspector_backend.py (Diff revision 1)
An issue was opened. Show all issues
```
E126 continuation line over-indented for hanging indent
```
reviewboard/codeinspector/pygments_lexer_code_inspector_backend.py (Diff revision 1)
An issue was opened. Show all issues
```
E126 continuation line over-indented for hanging indent
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 1)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/diffviewer/chunk_generator.py (Diff revision 1)
An issue was opened. Show all issues
```
E501 line too long (109 > 79 characters)
```
reviewboard/urls.py (Diff revision 1)
An issue was opened. Show all issues
```
E265 block comment should start with '# '
```

Description:

~		Added CodeInspectorInfoboxView with dummy URL.
~		Configured DiffReviewableView to manage/create CodeInspectorInfoboxViews
~		Code Inspector Infobox mockup using temporary API.
~		Implement CodeInspector base classes
~		Implement Pygments Lexer code inspector
	~	Create template tags for wrapping code references
	~	Added CodeInspectorInfoboxView with dummy URL.
	~	Configured DiffReviewableView to manage/create CodeInspectorInfoboxViews
	~	Code Inspector Infobox mockup using temporary API.
	~	Implement CodeInspector base classes
	+	Implement Pygments Lexer code inspector

Commit:

1c679d87876b44e4f5822202eb4878829886bbd2

3499ecfd1e2e4b92a206a47c9c1494117f72227c

Diff:

Revision 2 (+705 -4)

Show changes

	reviewboard/settings.py
	reviewboard/staticbundles.py
	reviewboard/urls.py
	reviewboard/codeinspector/__init__.py
	reviewboard/codeinspector/code_inspector_backends.py
	reviewboard/codeinspector/code_reference_backends.py
	reviewboard/codeinspector/pygments_lexer_code_inspector_backend.py
	reviewboard/codeinspector/views.py
	10 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/codeinspector/code_inspector_backends.py (Diff revision 2)
An issue was opened. Show all issues
```
W391 blank line at end of file
```
reviewboard/codeinspector/pygments_lexer_code_inspector_backend.py (Diff revision 2)
An issue was opened. Show all issues
```
E126 continuation line over-indented for hanging indent
```
reviewboard/codeinspector/pygments_lexer_code_inspector_backend.py (Diff revision 2)
An issue was opened. Show all issues
```
E126 continuation line over-indented for hanging indent
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
E122 continuation line missing indentation or outdented
```
reviewboard/diffviewer/chunk_generator.py (Diff revision 2)
An issue was opened. Show all issues
```
F401 'traceback' imported but unused
```

reviewboard/diffviewer/chunk_generator.py (Diff revision 2)

An issue was opened. Show all issues

F401 'reviewboard.codeinspector.pygments_lexer_code_inspector_backend.PygmentsLexerCodeInspectorBackend' imported but unused

reviewboard/diffviewer/chunk_generator.py (Diff revision 2)
An issue was opened. Show all issues
```
E501 line too long (109 > 79 characters)
```
reviewboard/diffviewer/diffutils.py (Diff revision 2)
An issue was opened. Show all issues
```
E501 line too long (85 > 79 characters)
```
reviewboard/diffviewer/diffutils.py (Diff revision 2)
An issue was opened. Show all issues
```
E702 multiple statements on one line (semicolon)
```
reviewboard/diffviewer/diffutils.py (Diff revision 2)
An issue was opened. Show all issues
```
E501 line too long (88 > 79 characters)
```
reviewboard/urls.py (Diff revision 2)
An issue was opened. Show all issues
```
E265 block comment should start with '# '
```

Fix it!

reviewboard/codeinspector/code_inspector_backends.py (Diff revision 2)

An issue was opened. Show all issues

New files should include module docstrings at the top (like """Base for code inspector backends""")

reviewboard/codeinspector/code_reference_backends.py (Diff revision 2)
An issue was opened. Show all issues
```
Module docstring for new file.
```
reviewboard/codeinspector/code_reference_backends.py (Diff revision 2)
An issue was opened. Show all issues
```
Class docstring.
```
reviewboard/codeinspector/pygments_lexer_code_inspector_backend.py (Diff revision 2)
An issue was opened. Show all issues
```
Module docstring for new file.
```
reviewboard/codeinspector/pygments_lexer_code_inspector_backend.py (Diff revision 2)
An issue was opened. Show all issues
```
Class docstring.
```
reviewboard/codeinspector/views.py (Diff revision 2)
An issue was opened. Show all issues
```
Module docstring for new file.
```
reviewboard/diffviewer/tests/test_insert_code_references.py (Diff revision 2)
An issue was opened. Show all issues
```
Module dosctring for new file.
```
reviewboard/diffviewer/tests/test_insert_code_references.py (Diff revision 2)
An issue was opened. Show all issues
```
Don't need a space here.
```
reviewboard/diffviewer/tests/test_insert_code_references.py (Diff revision 2)
An issue was opened. Show all issues
```
This should be alphabetically sorted with the other imports.
```

Status:: Discarded