search

ryanjgallagher / focalevents

Tools for collecting social media data around focal events
MIT License
84 stars 15 forks source link

Documentation says config_f instead of config #5

Closed FlxVctr closed 2 years ago

FlxVctr commented 2 years ago

Here: https://focalevents.readthedocs.io/en/latest/cookbook/twitter/search.html#search-parameters should be config, at least as I read the code.

ryanjgallagher commented 2 years ago

I think config_f should be correct for the search parameters. In the code, config is the actual dictionary that gets read from the YAML file specified by config_f.

Does that match your understanding of the code?

FlxVctr commented 2 years ago

Yes, that makes sense, but I think there's an omission in the code here:

https://github.com/ryanjgallagher/focalevents/blob/21b958c757b8aae88e3242730ae6f40684833ec9/twitter/search.py#L737

config instead of config_f

Made a PR, but not tested

ryanjgallagher commented 2 years ago

Ah I see, the issue was with the parser argument name. Thank you!