Hello Josh,

Sorry for the slow reply.  Another person asked a similar question
privately, so I will borrow my answer from there:

----------------------------------

Yeah, that is one area where the plan is a little squishy.  Buried at the
end of my "explanation" is the following cryptic (in retrospect) statement:
"Furthermore, consideration and expansion of our own API "desc" elements is
highly recommended, but is also outside the limited scope of this project."



In short, I ran out of steam trying to quantify them, so I tried setting
the comment % bar to the lower end of the spectrum in recognition of that.  We
definitely don't want to duplicate that data into comments, I think.  I
hope to take another crack at adding those to the big picture, but wanted
to get something out the door.


----------------------------------


To speak more directly to your comments, you are right that the API-level
documentation is very uneven, and I definitely encourage their expansion.
I don't foresee finding time to do analysis in that area for this release,
but that doesn't mean we won't be able to calculate in retrospect and
evaluate if any progress was made.  Thank you for asking!

Sincerely,
Dan


On Fri, Jan 26, 2018 at 10:54 AM, Josh Stompro <stomp...@exchange.larl.org>
wrote:

> Dan, I’m curious if your comment coverage counts the Opensrf method
> documentation?  The   “__PACKAGE__->register_method(“ signature/notes =>
> info?
>
>
>
> I’ve noticed that sometimes those are very complete
> <http://git.evergreen-ils.org/?p=Evergreen.git;a=blob;f=Open-ILS/src/perlmods/lib/OpenILS/Application/Actor/Container.pm;h=badb13482d2c31c0c7b42ec3d85d0be70bb40f2c;hb=HEAD#l327>
> with a description, notes, parameter dos, and return value docs, while
> others are very basic
> <http://git.evergreen-ils.org/?p=Evergreen.git;a=blob;f=Open-ILS/src/perlmods/lib/OpenILS/Application/Actor/Container.pm;h=badb13482d2c31c0c7b42ec3d85d0be70bb40f2c;hb=HEAD#l475>.
> That might be another aspect of the code documentation to evaluate and work
> on if someone is adding comments to a specific file.
>
>
>
> Josh Stompro - LARL IT Director
>
>
>
> *From:* Open-ils-general [mailto:open-ils-general-
> boun...@list.georgialibraries.org] *On Behalf Of *Daniel Wells
> *Sent:* Thursday, January 25, 2018 11:28 AM
> *To:* Evergreen Discussion Group <open-ils-general@list.
> georgialibraries.org>
> *Subject:* [OPEN-ILS-GENERAL] Evergreen 3.1 Release Update
>
>
>
> Hello all,
>
> We are now entering the busy period of the release cycle, so I would like
> to take a moment to highlight a variety of efforts underway for the 3.1
> release.
>
>
>
> 1) We are about two weeks away from "feature slush", currently set for
> Feb. 9.  What does this mean?  To quote from our "versioning" wiki page it
> means: "major planning for features is complete; at this point, all
> significant features should either have been merged or at least have LP
> bugs and pullrequests".  Of course, the nature of slush is that it isn't
> very solid, so there is still some flexibility at this stage, but if this
> deadline isn't met, chances of getting a new feature into the release begin
> to diminish considerably.  Please take note!
>
>
>
>
>
> 2) We are one month from feature freeze for 3.1 (Feb. 23).  Updates to the
> roadmap continue to come in:
>
> https://wiki.evergreen-ils.org/doku.php?id=faqs:evergreen_roadmap:3.1
>
>
>
> For example, an interesting new entry was added last week regarding more
> search improvements (https://bugs.launchpad.net/evergreen/+bug/1744385).
> Thank you, MassLNC and Equinox!
>
>
>
> To everyone, please continue to add to, update, and revise the roadmap
> throughout the feature slush period.
>
>
>
>
>
> 3) As part of my release goal to improve documentation and understanding
> for new developers, I have done some basic comment analysis of our Perl
> services code, and created a sign up matrix for anyone wishing to help
> nudge things forward.  For more explanation, or to sign up, please see here:
>
> https://docs.google.com/spreadsheets/d/17XCFAxuLvYKdjk4uDhlzzAZC28AGy
> QV3vugTnBXBtzg/edit?usp=sharing
>
>
>
>
>
> 4) Bill Erickson in late December published his first set of notes
> regarding a transition from AngularJS to Angular:
>
> https://wiki.evergreen-ils.org/doku.php?id=dev:browser_staff:angular5
>
>
>
> Moving fully over for 3.1 was always a stretch goal, but I think simpler
> changes like Bill's proposal to switch to Webpack are very doable in this
> release to help smooth the way.  Thank you, Bill!
>
>
>
>
>
> 5) I have made a first pass at making sure the roadmap and the related
> bugs in LP are in sync, and also getting various bugs to their proper tags
> and targets.  To help us all make use of LP more effectively, Remington and
> I have also made notable progress in getting usable results out of
> LaunchPad's web API, and are experimenting with generating simpler views as
> a release "dashboard" of sorts (nothing fancy at this stage).  We hope to
> have something to show in the next week or so; please stay tuned.
>
>
>
>
>
> 6) Not directly 3.1 related, but worth mentioning as general release
> news.  For the last point-releases, we did an initial trial run of using a
> signup sheet for splitting build tasks among the buildmaster volunteers.
> It is basic, but I do think it will help spread the load over time.  You
> can see that sheet here:
>
> https://docs.google.com/spreadsheets/d/1gZayHfF7qK0zwLMEAXt-PbKBMiAM_
> F6EZguqzIYceBY/edit#gid=0
>
>
>
> It is never too late to help out with builds; just join the ##eg-release
> channel on FreeNode and make some noise, and we'll find you a seat.
>
>
>
>
>
> Sincerely,
>
> Dan
>

Reply via email to