Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonOresten committed Feb 13, 2025
1 parent 5f712e5 commit b9e1add
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ julia> using ProteinChains

julia> structure = pdb"1EYE" # string macro to fetch proteins from the PDB
[ Info: File exists: 1EYE
1-element ProteinStructure "1EYE.cif"
1-element ProteinStructure "1EYE.cif":
256-residue ProteinChain{Float64} (A)

julia> chain = structure["A"]
Expand Down
6 changes: 3 additions & 3 deletions src/io/download.jl
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ Downloads are cached in a temporary directory.
```jldoctest
julia> pdbentry("1EYE")
[ Info: Downloading file from PDB: 1EYE
1-element ProteinStructure "1EYE.cif"
1-element ProteinStructure "1EYE.cif":
256-residue ProteinChain{Float64} (A)
julia> pdb"1EYE" # string macro for convenience
[ Info: File exists: 1EYE
1-element ProteinStructure "1EYE.cif"
1-element ProteinStructure "1EYE.cif":
256-residue ProteinChain{Float64} (A)
julia> pdb"1EYE"A # string suffix to get a specific chain
Expand All @@ -45,7 +45,7 @@ julia> pdb"1EYE"A # string suffix to get a specific chain
julia> pdb"1EYE"1 # integer suffix to specify "ba_number" keyword
[ Info: Downloading file from PDB: 1EYE
2-element ProteinStructure "1EYE_ba1.cif"
2-element ProteinStructure "1EYE_ba1.cif":
256-residue ProteinChain{Float64} (A)
256-residue ProteinChain{Float64} (A-2)
```
Expand Down
2 changes: 1 addition & 1 deletion src/store/store.jl
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ ProteinStructureStore with 0 entries
julia> store["3HFM"] = pdb"3HFM"
[ Info: Downloading file from PDB: 3HFM
3-element ProteinStructure "3HFM.cif"
3-element ProteinStructure "3HFM.cif":
215-residue ProteinChain{Float64} (H)
214-residue ProteinChain{Float64} (L)
129-residue ProteinChain{Float64} (Y)
Expand Down

2 comments on commit b9e1add

@AntonOresten
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

  • Remove warning message when reading ProteinStructureStore files serialized prior to v0.6.
  • Set up Literate.jl (WIP)

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/125021

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.6.1 -m "<description of version>" b9e1adda4d32789c43e05b5b9219ab7328fded53
git push origin v0.6.1

Please sign in to comment.