Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
neelsmith committed Sep 15, 2021
1 parent 6f748ec commit 2f5cc84
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "CitableBase"
uuid = "d6f014bd-995c-41bd-9893-703339864534"
authors = ["Neel Smith <[email protected]>"]
version = "2.0.0"
version = "2.1.0"

[deps]
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
Expand Down
4 changes: 2 additions & 2 deletions docs/src/implementations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## `Urn`

- [CitableText.jl](https://github.com/cite-architecture/CitableText.jl)
- [CitableObject.jl](https://github.com/cite-architecture/CitableObject.jl)
- the `CtsUrn`, in [CitableText.jl](https://github.com/cite-architecture/CitableText.jl)
- the `Cite2Urn`, in [CitableObject.jl](https://github.com/cite-architecture/CitableObject.jl)



Expand Down
11 changes: 1 addition & 10 deletions docs/src/urns.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,10 @@ components(fake)[3] |> parts
"objectid"
```

All implementations of the `URN` interface should override `Base.show`, and dispatch the following two methods to type-specific functions:


All implementations of the `URN` interface should override `Base.show`, and dispatch the following three methods to type-specific functions:

- `validurn`
- `dropversion`
- `addversion`


## Real implementations

In practice, there are two URN classes that implement the `URN` abstract type:

1. the CTS URN (implemented in the [CitableText](https://cite-architecture.github.io/CitableText.jl/stable/) module)
2. the CITE2 URN (implemented in the [CitableObject](https://cite-architecture.github.io/CitableObject.jl/stable/) module).

0 comments on commit 2f5cc84

Please sign in to comment.