Bio::D...ibableI(3pm)

💖 Bio::DescribableI — the vibe 💖

okay bestie so this is Bio::DescribableI, a page from the User Contributed Perl Documentation, and it's literally an interface for objects that have human readable names and descriptions. that's it. that's the whole thing. and yet she's iconic 💅

---

✨ NAME ✨

Bio::DescribableI — an interface for objects that come with human readable names and descriptions 🫶

---

🌸 SYNOPSIS 🌸

first up, how do you even check that something is a describable object? like this, babes:

# to test this is a describable object

$obj->isa("Bio::DescribableI") ||
  $obj->throw("$obj does not implement the Bio::DescribableI interface");

and then the accessors, the lil getters, the moment you've all been waiting for:

# accessors

$name = $obj->display_name();
$desc = $obj->description();

no cap, that's genuinely the whole synopsis. short queen ✨

---

🦋 DESCRIPTION 🦋

so this interface describes the methods you're expected to find on describable objects — meaning objects that have human displayable names and descriptions. it's giving "contract", it's giving "if you're gonna call yourself describable, you better come correct". periodt 💅

---

💌 FEEDBACK 💌

Mailing Lists

user feedback is an integral part of the evolution of this and other Bioperl modules, fr fr. send your comments and suggestions preferably to one of the Bioperl mailing lists. your participation is much appreciated, bestie 🥹

bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

Support

please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

rather than to the module maintainer directly. lots of experienced and reponsive experts will be able look at the problem and quickly address it. please include a thorough description of the problem with code and data examples if at all possible 🙏

Reporting Bugs

report bugs to the Bioperl bug tracking system to help us keep track the bugs and their resolution. bug reports can be submitted via the web:

https://github.com/bioperl/bioperl-live/issues

---

👑 AUTHOR - Ewan Birney 👑

Email birney@sanger.ac.uk

shoutout Ewan, the original author, the main character of this manpage 🌟

---

🧚 Implementation Specific Functions 🧚

these functions are the ones that a specific implementation must define. so like, if you're implementing this interface, these are your homework. no skipping 🍓

display_name

Title   : display_name
Usage   : $string    = $obj->display_name()
Function: A string which is what should be displayed to the user
          the string should have no spaces (ideally, though a cautious
          user of this interface would not assume this) and should be
          less than thirty characters (though again, double checking
          this is a good idea)
Returns : A scalar
Status  : Virtual

so basically: ideally no spaces, ideally under thirty characters — but a cautious user of this interface would not assume either of those things, and double checking is a good idea. the vibes are "trust but verify" 💀

description

Title   : description
Usage   : $string    = $obj->description()
Function: A text string suitable for displaying to the user a
          description. This string is likely to have spaces, but
          should not have any newlines or formatting - just plain
          text. The string should not be greater than 255 characters
          and clients can feel justified at truncating strings at 255
          characters for the purposes of display
Returns : A scalar
Status  : Virtual

okay so this one is the long-form one: it's likely to have spaces (unlike display_name, which ideally doesn't), it should not have any newlines or formatting — just plain text, nothing fancy, no rich text era 😭 — and it should not be greater than 255 characters, and clients can feel justified at truncating strings at 255 characters for the purposes of display. so if you're a client and you chop at 255, you're valid, you're justified, you're within your rights 🫶

---

and that's the whole page, bestie. every option, every field, every word, all of it. you understood it, you ate, no crumbs left 💅✨

---

this was Bio::D...ibableI(3pm) from the User Contributed Perl Documentation, brought to you by perl v5.32.1, dated 2021-08-15. mwah, take care of her 🎀💖🌈