Fortran-FOSS-Programmers / Fortran-FOSS-Programmers/ford

Allow exclusion of this/self

Open
#687 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
458
Forks
138
PR merge metrics
No merged PRs in 30d

Description

It would be nice to be able to not show the `this/self` (sometimes called the "passed object dummy argument") argument in the generated documentation for type bound procedures. Also allowing it to not have a comment.

As you should never be passing this argument to a type bound procedure on use it is redundant and confusing to include it in the generated API docs.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files, tests, or entry points; begin by tracing how FORTRAN type-bound procedures are parsed and rendered in the documentation generator. Done means the generated API documentation can omit the `this/self` argument and optionally omit its comment, with coverage for both settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
fortran, python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.