RhinoCommon API with Comment function via.hypothes.is


#1

Did somebody else thought about using hypothes.is to share Annotations in the RhinoCommon API ?

https://via.hypothes.is/http://developer.rhino3d.com/api/RhinoCommon/html/N_Rhino.htm

some nice features like groups, ranking, etc…

shall we give it a try ?

Edit:
and even annotate this side :wink:
https://via.hypothes.is/https://discourse.mcneel.com/t/rhinocommon-api-with-comment-function-via-hypothes-is/38875


(Dale Fugier) #3

Hi Tom,

I’m not sure what the question is here. Can you explain further?

– Dale


#4

@dale
dear Dale - thanks for asking.
I like the idea of having a RhinoCommon-Documentation, that allows comments by the users - or links to this forum or vice versa. as the current documentation does not have this functionality - you can just use hypothes.
see the small annotation sidebar of above s link.

the question “shall we give it a try” was more addressed to other users - then to the mcneel stuff. But maybe you might like the idea as well.

best tom


(Dale Fugier) #5

@dan, do you have any thoughts on this?


(Steve Baer) #6

I don’t think we as “McNeel” should do anything about this. It is up to the users to use this system if they choose, but we will have no control over the commenting system.


(Dan Belcher) #7

I agree with Steve. I would only hope that - if the system is useful to those who try it out - they make sure to bring the most helpful comments to our attention (as we may not be aware of what is going on sometimes). If there is something wrong with the documentation, we need to hear about it …by whatever communication channel is best, though we prefer here.

I know that my goal - and I think others here would share it - is to make the canonical documentation (guides, samples, api references) as useful as possible “out-of-the-box.”


#8

@dale @dan @stevebaer
thanks for your discussion. I came across this idea because i searched for a possibility to remember stuff with certain entries in the api reference. Let me give an example:
I was checking for discontinuity
http://developer.rhino3d.com/api/RhinoCommon/html/T_Rhino_Geometry_Continuity.htm
The option i needed i found in Dales answer here


But enum 12 is not in the rhinocommon documentation.
It would be great to have a way, that (final) results from this forum get a proper place to be easily accessible. maybe with a (auto-generated) link list - “related topics in discourse”?


(Giulio Piacentino) #9

Hi guys,

That’s an annoying bug. We should fix it, hopefully soon. In this particular case, I think it should also not be documented. I put it on my list: RH-37054. In general, when such an “magic-number” advice is given, we should try to track it on youtrack and see what we can do about it.

This does not mean that some way of wiki-documenting the API might not be useful.


(Dale Fugier) #10

This enum is included in the WIP…


(Giulio Piacentino) #11

Oh, I see.