Skip to content

get_summary may be potentially broken or should be private #7

Description

@onlyphantom

To reproduce:

from emailnetwork.summary import DomainSummary
from emailnetwork.extract import MBoxReader

reader = MBoxReader('your-mbox-path')
summary.get_summary()

You get a Counter() call. I suspect your intention was to have get_summary() be called only by its internal methods, if so I suggest you change it to _get_summary().

The underscore prefix is meant as a hint to another programmer that a variable or method starting with a single underscore is intended for internal use. This convention is defined in PEP 8.

class Test:
    def __init__(self):
        self.foo = 11
       # internal attributes
        self._bar = 23

     def _private_cleaner(self):
          # internal use

Activity

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

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions