Skip to content
Snippets Groups Projects
Commit e0e84e8a authored by Andy Yates's avatar Andy Yates
Browse files

Improving error documentation for methods which now throw errors

parent 6f0f8eb6
No related branches found
No related tags found
No related merge requests found
...@@ -454,7 +454,7 @@ sub remove_db { ...@@ -454,7 +454,7 @@ sub remove_db {
Arg [2] : name to get the adaptor for in the registry. Arg [2] : name to get the adaptor for in the registry.
Example : my $db = Bio::EnsEMBL::Registry->get_db("Human", "core", "lite"); Example : my $db = Bio::EnsEMBL::Registry->get_db("Human", "core", "lite");
Returntype : adaptor Returntype : adaptor
Exceptions : none Exceptions : See get_DBAdaptor()
Status : At Risk. Status : At Risk.
: This is here for backwards compatibility only and may : This is here for backwards compatibility only and may
: be removed eventually. Solution is to make sure the : be removed eventually. Solution is to make sure the
...@@ -566,7 +566,9 @@ sub add_DBAdaptor { ...@@ -566,7 +566,9 @@ sub add_DBAdaptor {
Arg [3] : if set will not give warnings when looking for alias. Arg [3] : if set will not give warnings when looking for alias.
Example : $dba = Bio::EnsEMBL::Registry->get_DBAdaptor("Human", "core"); Example : $dba = Bio::EnsEMBL::Registry->get_DBAdaptor("Human", "core");
Returntype : DBAdaptor Returntype : DBAdaptor
Exceptions : none Exceptions : If $species is not defined and if no valid internal name
could be found for $species. If thrown check your API and DB
version
Status : Stable Status : Stable
=cut =cut
...@@ -935,7 +937,8 @@ sub add_adaptor { ...@@ -935,7 +937,8 @@ sub add_adaptor {
Arg [3] : name of the type to add the adaptor to in the registry. Arg [3] : name of the type to add the adaptor to in the registry.
Example : $adap = Bio::EnsEMBL::Registry->get_adaptor("Human", "core", "Gene"); Example : $adap = Bio::EnsEMBL::Registry->get_adaptor("Human", "core", "Gene");
Returntype : adaptor Returntype : adaptor
Exceptions : none Exceptions : Thrown if a valid internal name cannot be found for the given
name. If thrown check your API and DB version.
Status : Stable Status : Stable
=cut =cut
...@@ -1341,7 +1344,8 @@ sub change_access{ ...@@ -1341,7 +1344,8 @@ sub change_access{
script may crash as the API version won't match the script may crash as the API version won't match the
DB version. DB version.
Exceptions : None. Exceptions : Thrown if the given URL does not parse according to the above
scheme
Status : Stable Status : Stable
=cut =cut
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment