Skip to content

Commit

Permalink
fix docstring location
Browse files Browse the repository at this point in the history
  • Loading branch information
cmishra authored Nov 12, 2024
1 parent 6c1f0d4 commit 741972b
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions src/parsers/CIF.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,6 @@ import { conversionMatrix3, Matrix3, Matrix4, Vector3 } from "../WebGL";
import { assignPDBBonds } from "./utils/assignPDBBonds";
import { AtomSpec } from "specs";

/**
* Puts atoms specified in mmCIF fromat in str into atoms
*
* @param {string} str
* @param {ParserOptionsSpec} options
* @category Parsers
*/

//coordinate conversion
const fractionalToCartesian = function (
cmat: Matrix3,
Expand All @@ -24,6 +16,13 @@ const fractionalToCartesian = function (
return new Vector3(x, y, z).applyMatrix3(cmat);
};

/**
* Puts atoms specified in mmCIF fromat in str into atoms
*
* @param {string} str
* @param {ParserOptionsSpec} options
* @category Parsers
*/
export function CIF(str: string, options: ParserOptionsSpec = {}) {
const atoms: Array<AtomSpec[]> & { modelData?: unknown } = [];
const noAssembly = !options.doAssembly; // don't assemble by default
Expand Down

0 comments on commit 741972b

Please sign in to comment.