samvera-labs / hydra_plugins_wg

Work area for the Hydra Plugins Working Group
Apache License 2.0
1 stars 0 forks source link

Add a YARD doc for private classes which aren't meant to be used externally. #72

Open tpendragon opened 7 years ago

jeremyf commented 7 years ago

Is there a consideration for using private_constant to ensure that programmatically ensure that constants aren't used externally?

carolyncole commented 7 years ago

Should use the private tag AND the flag on the yard doc creation. Should go right under the api tag description

carolyncole commented 7 years ago

Here is an example of the private_constant https://gist.github.com/zilkey/7109439