is_valid_doc_id#

scikitplot.mcp.is_valid_doc_id(value)[source]#

Return whether value is an acceptable document identifier.

Parameters:
valueobject

Candidate identifier. A non-string is not an identifier and is answered False rather than raised on, so a caller validating untrusted input gets a decision instead of a traceback.

Returns:
bool

True when the value matches DOC_ID_RE.

Parameters:

value (object)

Return type:

bool