Skip to content

Commit c4a9959

Browse files
committed
integrated docs for CG_fiber dataset
- fix #27 - added CHANGELOG entry - make fetch_CG_fiber() show up in docs
1 parent 2e37637 commit c4a9959

File tree

5 files changed

+10
-5
lines changed

5 files changed

+10
-5
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8+
### Added
9+
- new `fetch_CG_fiber()` to get CG_fiber dataset (PR #24)
10+
811
### Fixes
912
- fixed fetch_adk_transitions_DIMS() failed to fetch (#19)
1013
- added six to install requirements (#22)

MDAnalysisData/CG_fiber.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def fetch_CG_fiber(data_home=None, download_if_missing=True):
6262
Description of the trajectory.
6363
6464
65-
See :ref:`CG_fiber` for description.
65+
See :ref:`CG_fiber-dataset` for description.
6666
"""
6767
name = NAME
6868
data_location = join(get_data_home(data_home=data_home),
@@ -83,6 +83,6 @@ def fetch_CG_fiber(data_home=None, download_if_missing=True):
8383
file_type, meta.url, local_path))
8484
archive_path = _fetch_remote(meta, dirname=data_location)
8585

86-
#records.DESCR = _read_description(DESCRIPTION)
86+
records.DESCR = _read_description(DESCRIPTION)
8787

8888
return records

MDAnalysisData/descr/CG_fiber.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. -*- coding: utf-8 -*-
22
3-
.. _`CG_fiber`:
3+
.. _`CG_fiber-dataset`:
44

5-
CG fiber dataset
6-
==================================
5+
CG fiber dataset
6+
================
77

88
MD trajectory showing the self-assembly of an amphiphilic molecule.
99

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,4 @@ of pull requests are very welcome.
8989
ifabp_water
9090
nhaa_equilibrium
9191
vesicles
92+
CG_fiber

docs/usage.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ represent. The currently included datasets are:
2121
ifabp_water
2222
nhaa_equilibrium
2323
vesicles
24+
CG_fiber
2425

2526
Accessing a dataset
2627
===================

0 commit comments

Comments
 (0)