-
Notifications
You must be signed in to change notification settings - Fork 22
Closed
Labels
documentationSolely about the documentation of the project.Solely about the documentation of the project.good first issueGood first issue for people wanting to contribute to this project.Good first issue for people wanting to contribute to this project.
Milestone
Description
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.Solely about the documentation of the project.good first issueGood first issue for people wanting to contribute to this project.Good first issue for people wanting to contribute to this project.
Type
Projects
Status
Done