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

Sanketdg/assemble #2423

Merged
merged 10 commits into from Aug 14, 2016

Conversation

6 participants
@SanketDG
Member

SanketDG commented Jul 3, 2016

No description provided.

@sils

This comment has been minimized.

Show comment
Hide comment
@sils

sils Jul 4, 2016

Member

ack 047c634

Member

sils commented Jul 4, 2016

ack 047c634

@sils

This comment has been minimized.

Show comment
Hide comment
@sils

sils Jul 4, 2016

Member

hey, coverage is lowered?

Member

sils commented Jul 4, 2016

hey, coverage is lowered?

@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG

SanketDG Jul 4, 2016

Member

@sils1297 yes I will need some help on that. I am not sure why.

Member

SanketDG commented Jul 4, 2016

@sils1297 yes I will need some help on that. I am not sure why.

@Adrianzatreanu

This comment has been minimized.

Show comment
Hide comment
@Adrianzatreanu

Adrianzatreanu Jul 4, 2016

Contributor

01e42e2 imo the commit body could use some work, especially the tense used :D

Contributor

Adrianzatreanu commented Jul 4, 2016

01e42e2 imo the commit body could use some work, especially the tense used :D

@Makman2 Makman2 self-assigned this Jul 5, 2016

@gitmate-bot gitmate-bot added size/L and removed size/M labels Jul 12, 2016

@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG
Member

SanketDG commented Jul 12, 2016

reack 199b4fe

@Makman2

This comment has been minimized.

Show comment
Hide comment
@Makman2
Member

Makman2 commented Jul 14, 2016

ack 7df0651

@Makman2

This comment has been minimized.

Show comment
Hide comment
@Makman2
Member

Makman2 commented Jul 14, 2016

ack a47ac62

@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG

SanketDG Jul 16, 2016

Member

reack aec16c2 8f0a067 36ee174

Member

SanketDG commented Jul 16, 2016

reack aec16c2 8f0a067 36ee174

@gitmate-bot

View changes

Show outdated Hide outdated tests/bearlib/languages/documentation/AssembledDocumentationTest.py
@gitmate-bot

This comment has been minimized.

Show comment
Hide comment
@gitmate-bot

gitmate-bot Jul 16, 2016

Collaborator

Comment on 88507b291064f596e19d4474b958d440908725eb, file tests/bearlib/languages/documentation/AssembledDocumentationTest.py, line 1.

This file contains unused source code.

PyUnusedCodeBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/tests/bearlib/languages/documentation/AssembledDocumentationTest.py
+++ b/tests/bearlib/languages/documentation/AssembledDocumentationTest.py
@@ -1,4 +1,3 @@
-import os
 import unittest

 from coalib.bearlib.languages.documentation.AssembledDocumentation import (
Collaborator

gitmate-bot commented Jul 16, 2016

Comment on 88507b291064f596e19d4474b958d440908725eb, file tests/bearlib/languages/documentation/AssembledDocumentationTest.py, line 1.

This file contains unused source code.

PyUnusedCodeBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/tests/bearlib/languages/documentation/AssembledDocumentationTest.py
+++ b/tests/bearlib/languages/documentation/AssembledDocumentationTest.py
@@ -1,4 +1,3 @@
-import os
 import unittest

 from coalib.bearlib.languages.documentation.AssembledDocumentation import (
@Makman2

This comment has been minimized.

Show comment
Hide comment
@Makman2

Makman2 Jul 16, 2016

Member

don't know whether we should do de59748 , as such load functions are often quite specific to their directories. If you think this modularization makes sense, you can keep it 👍
Or maybe we can just move this function outside the class, your choice :D

Member

Makman2 commented Jul 16, 2016

don't know whether we should do de59748 , as such load functions are often quite specific to their directories. If you think this modularization makes sense, you can keep it 👍
Or maybe we can just move this function outside the class, your choice :D

@Makman2

View changes

Show outdated Hide outdated tests/bearlib/languages/documentation/DocumentationCommentTest.py
@Makman2

View changes

Show outdated Hide outdated tests/bearlib/languages/documentation/DocumentationCommentTest.py
@Makman2

View changes

Show outdated Hide outdated tests/bearlib/languages/documentation/DocumentationCommentTest.py
@Makman2

View changes

Show outdated Hide outdated coalib/bearlib/languages/documentation/DocumentationComment.py
@Makman2

This comment has been minimized.

Show comment
Hide comment
@Makman2

Makman2 Aug 14, 2016

Member

ack f42bf20

Member

Makman2 commented Aug 14, 2016

ack f42bf20

@Makman2

This comment has been minimized.

Show comment
Hide comment
@Makman2

Makman2 Aug 14, 2016

Member

ack d54201f

Member

Makman2 commented Aug 14, 2016

ack d54201f

SanketDG added some commits Jul 3, 2016

DocumentationComment: Fix python parsing
For the format:

:param param1:
    param description
:return:
    return description

The current parsing fails because no space is expected after the
second ':'. So no space is taken into account.
DocumentationComment: Remove redundant code
No need for try-except, since there will be a guaranteed newline.
DocstyleDefinition: Add metadata param
This metadata param will contain all of the required
documentation symbols that will be needed to parse the
documentation.

`param_start`, `param_end` and `return_sep` are the contents of
the metadata.
DocumentationComment: Use DocstyleDefinition
A docstyle_definition is now used to store the language, docstyle
and the symbols.
DocumentationExtraction: Fix newline parsing
For documentation comments where marker[1] = "", empty newlines
are not considered since they do not have the indentation.
DocumentationComment: Add from_metadata()
This function acts as a constructor to assemble a list of parsed
documentation comments. It sets up the assemble() function.
DocumentationComment: Add assemble()
This function takes in a ``DocumentationComment`` instance and
assembles it to a documentation comment as a string.

To have tests on all corner cases, documentation styles in
default.py has changed.

Also, a default.c is created to test corner cases, for a docstyle
having a different marker. (i.e. marker[1] != "")
@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG
Member

SanketDG commented Aug 14, 2016

@rultor merge

@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Aug 14, 2016

Contributor

@rultor merge

@SanketDG OK, I'll try to merge now. You can check the progress of the merge here

Contributor

rultor commented Aug 14, 2016

@rultor merge

@SanketDG OK, I'll try to merge now. You can check the progress of the merge here

@rultor rultor merged commit 78ff315 into master Aug 14, 2016

8 checks passed

Scrutinizer 5 new issues, 14 updated code elements
Details
ci/circleci Your tests passed on CircleCI!
Details
codecov/project 100% (target 100%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
dependency-ci Dependencies checked
Details
review/gitmate/commit No issues with this one - go ahead! :)
Details
review/gitmate/manual This commit was acknowledged.
Details
review/gitmate/pr All is well! :) (0 problems solved)
Details
@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Aug 14, 2016

Contributor

@rultor merge

@SanketDG Done! FYI, the full log is here (took me 1min)

Contributor

rultor commented Aug 14, 2016

@rultor merge

@SanketDG Done! FYI, the full log is here (took me 1min)

@AbdealiJK AbdealiJK deleted the sanketdg/assemble branch Aug 28, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment