P123 Documentation Standards / NodeRank Example

Dear P123 Team,

The following happens a little bit more often than it should: I look up a function / factor, read the documentation, spend time planning its use, try to use it, and it fails.

Example: NodeRank. It was deprecated quite some time ago, but current documentation states,

“…The function can be used in Buy/Sell and screener rules. However the simulation will run much slower since the ranks must be computed everytime the simulation is run to access the individual components…”

Suggestion: IF XYZ deprecated / altered, THEN c a r e f u l l y update XYZ’s user documentation.

I know you accomplish a great deal with slim overhead, and you turn many of us into loyal fans by doing so.

But, with all due respect, user documentation standards should be higher. It doesn’t cost much time or effort to step up on this point. Just a belief that consistently reliable documentation across the platform is important.

Thanks in advance for help with this.

Best, D

Durandus - where does it say NodeRank was deprecated?
Steve

I suggested the idea of a p123 wiki some time ago

SZ - Wikis are a lot of work and discipline. I’m not sure how many people would be able to spend the time on it.
Steve

Hi Steve, it appears to have been deprecated for Buy / Sell rules only. “Rating” is suggested as a work-around in Buy /Sell.

See this thread from Marco:

https://www.portfolio123.com/mvnforum/viewthread_thread,5738#27114

Regards, D

Hi SZ, I think the structure of what is in place now is fine. What would help is a more rigorous approach to timely and precise documentation updates - across the platform (Screener / Ranking / Simulation / Portfolios) - when changes are implemented. Kind regards, D

D - thanks for pointing this out. I’ve put in a feature request that might make things a bit easier.
Steve

Dear All,

Please see Sir Stittsville’s great idea here: https://www.portfolio123.com/mvnforum/viewthread_thread,8115

Please vote for it. I think it would dramatically improve user documentation.

Good idea!