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

Incorrect dtrace probe information #4445

Closed
albert-github opened this issue Sep 17, 2023 · 8 comments · Fixed by #4447
Closed

Incorrect dtrace probe information #4445

albert-github opened this issue Sep 17, 2023 · 8 comments · Fixed by #4447
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed

Comments

@albert-github
Copy link

albert-github commented Sep 17, 2023

* @actor is the actor that was created

Probably intended \param actor is the actor that was created

* @param actor_to is the receiving actor

actor_to -> actor

* @params scheduler is the active scheduler

\params -> \param

* @params actor is the actor that finished receiving an object

\params -> \param

Also some problems:

ponyc-0.56.2/src/libponyc/pkg/platformfuns.h:30: warning: argument 'out_is' of command @param is not found in the argument list of os_is_target(const char *attribute, bool release, bool *out_is_target, pass_opt_t *options)
ponyc-0.56.2/src/libponyc/pkg/platformfuns.h:30: warning: The following parameters of os_is_target(const char *attribute, bool release, bool *out_is_target, pass_opt_t *options) are not documented:
  parameter 'attribute'
  parameter 'release'
  parameter 'out_is_target'
  parameter 'options'
@albert-github albert-github changed the title Small documenttaion problems Small documentation problems Sep 17, 2023
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Sep 17, 2023
@SeanTAllen SeanTAllen added help wanted Extra attention is needed bug Something isn't working good first issue Good for newcomers labels Sep 17, 2023
@SeanTAllen SeanTAllen changed the title Small documentation problems Incorrect dtrace probe information Sep 17, 2023
@SeanTAllen
Copy link
Member

@albert-github would you be up for opening a PR to fix these?

@albert-github
Copy link
Author

Biggest problem I'm not using ponyc and have no idea what the descriptions in platformfuns.h should be.

@SeanTAllen
Copy link
Member

@albert-github what did you do that resulted in getting the platformfuns.h warnings?

@albert-github
Copy link
Author

Doxygen was run over the source (doxygen has only very limited D capabilities though) with a brute force doxygen settings file (Doxyfile).

@SeanTAllen
Copy link
Member

@albert-github the platformfuns isn't a dtrace problem related item so i'm not worried about it. I've opened a PR for the other items.

SeanTAllen added a commit that referenced this issue Sep 17, 2023
"Typos" basically.

Fixes #4445
@SeanTAllen
Copy link
Member

thanks @albert-github

@albert-github
Copy link
Author

So where should the platformfuns related problems be reported?

@SeanTAllen
Copy link
Member

@albert-github i already opened a PR to address it.

SeanTAllen added a commit that referenced this issue Sep 19, 2023
@ponylang-main ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants