Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add configuration option for handling unresolved types in DRIs #637

Open
Kordyjan opened this issue Feb 11, 2020 · 0 comments
Open

Add configuration option for handling unresolved types in DRIs #637

Kordyjan opened this issue Feb 11, 2020 · 0 comments
Assignees
Labels
enhancement An issue for a feature or an overall improvement tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life

Comments

@Kordyjan
Copy link
Contributor

Right now, when during generation of DRI dokka encounters UnresolvedType it puts there reference to type constructor with empty name. This is unacceptable. The three acceptable strategies of handling that are:

  • to crash entire generation process with exception
  • to skip generation of documentable for any elements that have unresolvable symbols in their DRIs and emit warnings
  • to provide approximation of type constructor fq-name by just using name that failed resolution. In the future we can refine this approximation by using information from import list of enclosing source file.

The goal of this task is to implement those strategies and provide configuration option to switch between them. First option should be the default one.

@Kordyjan Kordyjan added the enhancement An issue for a feature or an overall improvement label Feb 11, 2020
@Kordyjan Kordyjan added this to the 0.11.0 milestone Feb 11, 2020
@sswistun-vl sswistun-vl self-assigned this Mar 5, 2020
@sswistun-vl sswistun-vl linked a pull request Mar 9, 2020 that will close this issue
@Kordyjan Kordyjan removed this from the 0.11.0 milestone Jun 29, 2020
@MarcinAman MarcinAman added this to the Stable milestone Apr 26, 2021
@IgnatBeresnev IgnatBeresnev added the tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life label Mar 14, 2023
@IgnatBeresnev IgnatBeresnev removed this from the Backlog milestone Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants