stubsgen: Newly exposed itterables need documenting
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- Rust
- Stars
- 642
- Forks
- 70
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 21
Description
need to idetify where to add comments so that docs for the following are picked up by stubsgen
WARNING:raphtory.iterables.NestedUtcDateTimeIterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedGIDIterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedGIDIterable.max:Missing documentation
WARNING:raphtory.iterables.NestedGIDIterable.min:Missing documentation
WARNING:raphtory.iterables.GIDIterable.collect:Missing documentation
WARNING:raphtory.iterables.GIDIterable.max:Missing documentation
WARNING:raphtory.iterables.GIDIterable.min:Missing documentation
WARNING:raphtory.iterables.StringIterable.collect:Missing documentation
WARNING:raphtory.iterables.OptionArcStringIterable.collect:Missing documentation
WARNING:raphtory.iterables.UsizeIterable.collect:Missing documentation
WARNING:raphtory.iterables.UsizeIterable.max:Missing documentation
WARNING:raphtory.iterables.UsizeIterable.mean:Missing documentation
WARNING:raphtory.iterables.UsizeIterable.min:Missing documentation
WARNING:raphtory.iterables.UsizeIterable.sum:Missing documentation
WARNING:raphtory.iterables.OptionI64Iterable.collect:Missing documentation
WARNING:raphtory.iterables.OptionI64Iterable.max:Missing documentation
WARNING:raphtory.iterables.OptionI64Iterable.min:Missing documentation
WARNING:raphtory.iterables.NestedOptionArcStringIterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedStringIterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedOptionI64Iterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedOptionI64Iterable.max:Missing documentation
WARNING:raphtory.iterables.NestedOptionI64Iterable.min:Missing documentation
WARNING:raphtory.iterables.NestedI64VecIterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedUsizeIterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedUsizeIterable.max:Missing documentation
WARNING:raphtory.iterables.NestedUsizeIterable.mean:Missing documentation
WARNING:raphtory.iterables.NestedUsizeIterable.min:Missing documentation
WARNING:raphtory.iterables.NestedUsizeIterable.sum:Missing documentation
WARNING:raphtory.iterables.BoolIterable.collect:Missing documentation
WARNING:raphtory.iterables.ArcStringIterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedVecUtcDateTimeIterable.collect:Missing documentation
WARNING:raphtory.iterables.OptionVecUtcDateTimeIterable.collect:Missing documentation
WARNING:raphtory.iterables.GIDGIDIterable.collect:Missing documentation
WARNING:raphtory.iterables.GIDGIDIterable.max:Missing documentation
WARNING:raphtory.iterables.GIDGIDIterable.min:Missing documentation
WARNING:raphtory.iterables.NestedGIDGIDIterable.collect:Missing documentation
WARNING:raphtory.iterables.NestedGIDGIDIterable.max:Missing documentation
WARNING:raphtory.iterables.NestedGIDGIDIterable.min:Missing documentation
WARNING:raphtory.iterables.NestedBoolIterable.collect:Missing documentation
WARNING:raphtory.iterables.U64Iterable.collect:Missing documentation
WARNING:raphtory.iterables.U64Iterable.max:Missing documentation
WARNING:raphtory.iterables.U64Iterable.mean:Missing documentation
WARNING:raphtory.iterables.U64Iterable.min:Missing documentation
WARNING:raphtory.iterables.U64Iterable.sum:Missing documentation
WARNING:raphtory.iterables.OptionUtcDateTimeIterable.collect:Missing documentation
WARNING:raphtory.iterables.ArcStringVecIterable.collect:Missing documentation
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the definitions for raphtory.iterables and the stubsgen invocation, then compare existing documented iterable methods. Add documentation for each listed warning and rerun stubsgen; done means the Missing documentation warnings are resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 42/100