Improve FACT documentation

[ettermyra]

Just getting my bearings in the FACT code and perhaps I'm misinterpreting somethin but I'm wondering if common_helper_files is equivalent to helperFiles and also if get_dir_of_file() is equivalent to get_directory_of_current_file() in fileSystem? If so, I gather that the former are to be deprecated? If so, this should be documented.

The plugin template is well documented in its basics but methods on how to access the results of other plugins, or what helper functions are available to your plugin or the preferred method on how to access global config file settings etc. should also be documented. One have to sift through a lot of code in order to find out how this works, which in it self is educating of course, but rather time consuming.

[weidenba]

helperFunctions.fileSystem.get_directory_of_current_file() should always return the absolut path of "FACT_core/src/helperFunctions". This function was intended to be used as anchor to adress specific locations in the FACT_core folder. However it was not intended to be used outside of helperFunctions.fileSystem.

common_helper_files.get_dir_of_file(file_path)

Returns absolute path of the directory including the file

However, you are absolutly right: Documentation must be improved and we are working on that. Unfortunately, documentation is not a high priority for the guys, who pay for the development, at the moment.

[dorpvom]

Always happy to update an old issue. We have started to add sphinx documentation to our helper functions and deploy them on our github.io page. We'll incrementally add to this and complete at least the helper functions module in the coming weeks.

After that we have to check what other modules need API docu (the most).