From ddc304451d90ad7b6e2cf2f32510e70428dc7034 Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavier.robin@unibas.ch>
Date: Tue, 2 Jan 2024 10:33:29 +0100
Subject: [PATCH] doc: SCHWED-6108 improved comments on chain_type
---
modules/mol/base/src/chain_type.cc | 2 ++
modules/mol/base/src/chain_type.hh | 4 ++--
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/modules/mol/base/src/chain_type.cc b/modules/mol/base/src/chain_type.cc
index 0820407c7..8b1c444bc 100644
--- a/modules/mol/base/src/chain_type.cc
+++ b/modules/mol/base/src/chain_type.cc
@@ -78,6 +78,8 @@ String StringFromChainType(ChainType type)
{
// chain types as found in the entity category of a mmcif file
if (CHAINTYPE_POLY == type) {
+ // "polymer" in _entity.type
+ // "other" in _entity_poly.type
return "polymer";
} else if (CHAINTYPE_NON_POLY == type) {
return "non-polymer";
diff --git a/modules/mol/base/src/chain_type.hh b/modules/mol/base/src/chain_type.hh
index 27e1910e6..f062606ec 100644
--- a/modules/mol/base/src/chain_type.hh
+++ b/modules/mol/base/src/chain_type.hh
@@ -30,8 +30,8 @@ namespace ost { namespace mol {
/// \enum different kinds of chains
///
/// Warning: this class mixes vocabulary from _entity.type and
-// _entity_poly.type, which is more detailed. As a result it cannot be used to
-/// to read/write mmCIF entity types accurately.
+// _entity_poly.type, which is more detailed. As a result it is not a 1:1
+// mapping and cannot be used to to read/write mmCIF entity types accurately.
typedef enum {
CHAINTYPE_POLY, ///< polymer
--
GitLab