Skip to content

Commit 435d346

Browse files
authored
Merge pull request #70 from code4lib/doc_tweaks
Trying to make docs a bit more user-friendly
2 parents 1886646 + 2e3dec2 commit 435d346

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The OAI provider library handles serving local content to other clients. Here's
6464
end
6565
```
6666

67-
See {OAI::Provider} for more details
67+
See comment docs at top of [OAI::Provider](./lib/oai/provider.rb) for more details, including discussion of the `OAI::Provider::ActiveRecordWrapper` class for quich setup of an OAI provider for an ActiveRecord model class (single database table)
6868

6969
Interactive Harvester
7070
---------------------

lib/oai/provider.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,11 @@
201201
# end
202202
# end
203203
# ```
204+
# ### Sets?
205+
#
206+
# There is some code written to support oai-pmh "sets" in the ActiveRecord::Wrapper, but
207+
# it's somewhat inflexible, and not well-documented, and as I write this I don't understand
208+
# it enough to say more. See https://github.com/code4lib/ruby-oai/issues/67
204209
#
205210
module OAI::Provider
206211
class Base

0 commit comments

Comments
 (0)