Todo

Todo

  • update the package tutorial if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/catalogue_conesearch.py:docstring of sherlock.catalogue_conesearch, line 21.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/catalogue_conesearch.py:docstring of sherlock.catalogue_conesearch, line 106.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/catalogue_conesearch.py:docstring of sherlock.catalogue_conesearch.search, line 11.)

Todo

  • write a checklist for adding a new catalogue to the sherlock database and reference it from here (use the image below of the tcs_helper_catalogue_views_info table)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/commonutils/get_crossmatch_catalogues_column_map.py:docstring of sherlock.commonutils.get_crossmatch_catalogues_column_map, line 6.)

Todo

  • create a new script for updating sherlock wiki with the snippet above, remove wiki command from cl-utils and add stand alone scripts to the sherlock repo (cleans up the usage and docs for sherlock)
  • harvest text from wiki pages and then delete them: https://github.com/thespacedoctor/sherlock/wiki

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/commonutils/update_wiki_pages.py:docstring of sherlock.commonutils.update_wiki_pages, line 20.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database.py:docstring of sherlock.database, line 32.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database.py:docstring of sherlock.database.connect, line 10.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database.py:docstring of sherlock.database._setup_tunnel, line 9.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database.py:docstring of sherlock.database._checkServer, line 3.)

Todo

  • add an entry in the tutorial to clean database tables

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner, line 12.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner, line 25.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner.clean, line 3.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner._updated_row_counts_in_tcs_helper_catalogue_tables_info, line 3.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner._update_tcs_helper_catalogue_tables_info_with_new_tables, line 3.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner._clean_up_columns, line 3.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner._update_tcs_helper_catalogue_views_info_with_new_views, line 3.)

Todo

  • Write a checklist for creating a new sherlock database importer

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/_base_importer.py:docstring of sherlock.imports._base_importer.add_data_to_database_table, line 18.)

Todo

  • abstract this module out into its own stand alone script
  • check sublime snippet exists

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ifs.py:docstring of sherlock.imports.ifs, line 20.)

Todo

  • Write a checklist for creating a new sherlock database importer

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ifs.py:docstring of sherlock.imports.ifs.add_data_to_database_table, line 18.)

Todo

  • abstract this module out into its own stand alone script
  • check sublime snippet exists

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/marshall.py:docstring of sherlock.imports.marshall, line 20.)

Todo

  • convert the directory_script_runner to ‘load in file’

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/marshall.py:docstring of sherlock.imports.marshall.ingest, line 7.)

Todo

  • Write a checklist for creating a new sherlock database importer

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/marshall.py:docstring of sherlock.imports.marshall.add_data_to_database_table, line 18.)

Todo

  • test this code is still working after changes
  • add option to filter coordinate list via the tcs_helper_ned_query_history table
  • check sublime snippet exists
  • clip any useful text to docs mindmap

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned.py:docstring of sherlock.imports.ned, line 35.)

Todo

  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned.py:docstring of sherlock.imports.ned.ingest, line 19.)

Todo

  • Write a checklist for creating a new sherlock database importer

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned.py:docstring of sherlock.imports.ned.add_data_to_database_table, line 18.)

Todo

  • abstract this module out into its own stand alone script

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d, line 26.)

Todo

  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d.ingest, line 9.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d._create_dictionary_of_ned_d, line 6.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d._clean_up_columns, line 3.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d._get_metadata_for_galaxies, line 3.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d._count_galaxies_requiring_metadata, line 6.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d._get_3000_galaxies_needing_metadata, line 6.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d._query_ned_and_add_results_to_database, line 6.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d._update_sdss_coverage, line 3.)

Todo

  • Write a checklist for creating a new sherlock database importer

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/ned_d.py:docstring of sherlock.imports.ned_d.add_data_to_database_table, line 18.)

Todo

  • abstract this module out into its own stand alone script
  • add ppmxl to stand-alone import scripts
  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/veron.py:docstring of sherlock.imports.veron, line 32.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/veron.py:docstring of sherlock.imports.veron._create_dictionary_of_veron, line 6.)

Todo

  • Write a checklist for creating a new sherlock database importer

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/imports/veron.py:docstring of sherlock.imports.veron.add_data_to_database_table, line 18.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_catalogue_crossmatch.py:docstring of sherlock.transient_catalogue_crossmatch, line 33.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_catalogue_crossmatch.py:docstring of sherlock.transient_catalogue_crossmatch.match, line 8.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_catalogue_crossmatch.py:docstring of sherlock.transient_catalogue_crossmatch.angular_crossmatch_against_catalogue, line 69.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_catalogue_crossmatch.py:docstring of sherlock.transient_catalogue_crossmatch._annotate_crossmatch_with_value_added_parameters, line 12.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_catalogue_crossmatch.py:docstring of sherlock.transient_catalogue_crossmatch._bright_star_match, line 12.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_catalogue_crossmatch.py:docstring of sherlock.transient_catalogue_crossmatch._galaxy_association_cuts, line 13.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_catalogue_crossmatch.py:docstring of sherlock.transient_catalogue_crossmatch.physical_separation_crossmatch_against_catalogue, line 29.)

Todo

  • update the package tutorial if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier, line 22.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier, line 74.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.classify, line 9.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._get_transient_metadata_from_database_list, line 6.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._update_ned_stream, line 6.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._remove_previous_ned_queries, line 9.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._crossmatch_transients_against_catalogues, line 11.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._update_transient_database, line 9.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._rank_classifications, line 11.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._print_results_to_stdout, line 7.)

Todo

  • add usage info
  • create a sublime snippet for usage
  • update package tutorial if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._consolidate_coordinateList, line 10.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._consolidate_coordinateList, line 20.)

Todo

  • add usage info
  • create a sublime snippet for usage
  • write a command-line tool for this method
  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.classification_annotations, line 10.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.classification_annotations, line 21.)

Todo

  • add usage info
  • create a sublime snippet for usage
  • write a command-line tool for this method
  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.update_classification_annotations_and_summaries, line 11.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.update_classification_annotations_and_summaries, line 23.)

Todo

  • add usage info
  • create a sublime snippet for usage
  • write a command-line tool for this method
  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.update_peak_magnitudes, line 10.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.update_peak_magnitudes, line 22.)

Todo

  • add usage info
  • create a sublime snippet for usage
  • write a command-line tool for this method
  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._create_tables_if_not_exist, line 10.)

Todo

  • update key arguments values and definitions with defaults
  • update return values and definitions
  • update usage examples and text
  • update docstring text
  • check sublime snippet exists
  • clip any useful text to docs mindmap
  • regenerate the docs and check redendering of this docstring

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/stable/lib/python2.7/site-packages/qub_sherlock-2.0.2-py2.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier._create_tables_if_not_exist, line 21.)

Todo

  • add tutorial

(The original entry is located in _includes/tutorial.rst, line 15.)

Todo

  • write about marshall stream updates
  • write about helper table updates
  • write that some tasks need automated

(The original entry is located in _includes/tutorial.rst, line 336.)

Todo

  • list current catalogue importers and how to use them
  • add tutorial about creating a new importer
  • add steps for adding a catalogue to the database and the search algorithm
  • add details about updating the column map
  • write code into conf.py to generate tables for docs and link them from here (views, tables and streams)

(The original entry is located in _includes/tutorial.rst, line 361.)

Todo

  • add tutorial

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/checkouts/stable/docs/source/_includes/tutorial.rst, line 15.)

Todo

  • write about marshall stream updates
  • write about helper table updates
  • write that some tasks need automated

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/checkouts/stable/docs/source/_includes/tutorial.rst, line 336.)

Todo

  • list current catalogue importers and how to use them
  • add tutorial about creating a new importer
  • add steps for adding a catalogue to the database and the search algorithm
  • add details about updating the column map
  • write code into conf.py to generate tables for docs and link them from here (views, tables and streams)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/checkouts/stable/docs/source/_includes/tutorial.rst, line 361.)

Todo

  • add tutorial

(The original entry is located in _includes/tutorial.rst, line 15.)

Todo

  • write about marshall stream updates
  • write about helper table updates
  • write that some tasks need automated

(The original entry is located in _includes/tutorial.rst, line 336.)

Todo

  • list current catalogue importers and how to use them
  • add tutorial about creating a new importer
  • add steps for adding a catalogue to the database and the search algorithm
  • add details about updating the column map
  • write code into conf.py to generate tables for docs and link them from here (views, tables and streams)

(The original entry is located in _includes/tutorial.rst, line 361.)