Skip to content

Development guide could benefit from code examples #83

@KristijanArmeni

Description

@KristijanArmeni

The problem

The development guide is a great starting point for anyone wishing to contribute. But it could use some code examples added in the markdown text (instead of just links to GitHub code)

Possible implementation

For example when it gives an instruction like this:

Add all the defined modules to the suite.

It would be more user friendly to also show an example code snippet (or pseudocode) below:

Add all the defined modules to the suite.

suite = AnalyzerSuite(
    all_analyzers=[
        example_base,
        example_report,
        example_web,
        ngrams,
        ngram_stats,
        ngrams_web,
        time_coordination,
        temporal,
        temporal_barplot,
        hashtags,
        # <--- add your analyzer here
    ]
)

Metadata

Metadata

Assignees

Labels

documentationSolely about the documentation of the project.good first issueGood first issue for people wanting to contribute to this project.

Type

No type

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions