Skip to content

docs: align JSDocs of experimental sf logic+structure functions #61887

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 5, 2025
Merged

docs: align JSDocs of experimental sf logic+structure functions #61887

merged 1 commit into from
Jun 5, 2025

Conversation

michael-small
Copy link
Contributor

@michael-small michael-small commented Jun 5, 2025 •
edited
Loading

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

Fixes a few outdated jsdoc comments for the signal forms.

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.dev application / infrastructure changes
  • Other... Please describe: unsure

What is the current behavior?

Outdated JSDocs for signal form functions

Issue Number: N/A

What is the new behavior?

JSDoc comment aligned

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

  1. @mmalerba said to tag you.
  2. There are two other types of things that I am fairly certain are outdated, but I am doubting myself enough to not commit directly
    • There is three usages of LogicNode across 3 files, like on line 68 of path_node.. I think those should be FieldLogicNode, but there is also normal FieldNode so idk if my initial assumption is right in all those cases.
    • Just like on that line, there is a FormPath that I think would be FieldPath now, as well as two formPath on line 54 in unwrapFieldPath.

edit: also, I may get around to doing a similar audit of the markdowns in a similar fashion to this PR if that's ok

@pullapprove pullapprove bot requested a review from devversion June 5, 2025 01:57
@angular-robot angular-robot bot added the area: docs Related to the documentation label Jun 5, 2025
@ngbot ngbot bot added this to the Backlog milestone Jun 5, 2025
@JeanMeche JeanMeche requested review from mmalerba and removed request for devversion June 5, 2025 04:58
@thePunderWoman thePunderWoman added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Jun 5, 2025
@thePunderWoman thePunderWoman force-pushed the sf/jsdoc-corrections branch from c208827 to ef776a3 Compare June 5, 2025 09:28
@thePunderWoman
Copy link
Contributor

@michael-small I'm not sure what's going on here, because nothing in this PR looks like it should introduce deps, but lint is showing circular dependencies. Can you take a look?

@JeanMeche
Copy link
Member

@thePunderWoman Issues are pre-existing, the target branch is the experimental forms which does not care (for now) about those errors.

@thePunderWoman thePunderWoman added the target: feature This PR is targeted for a feature branch (outside of main and semver branches) label Jun 5, 2025
@kirjs
Copy link
Contributor

kirjs commented Jun 5, 2025

Thank you for your contribution

@kirjs kirjs merged commit 5e675b1 into angular:prototype/signal-forms Jun 5, 2025
16 of 21 checks passed
@michael-small
Copy link
Contributor Author

michael-small commented Jun 5, 2025 •
edited
Loading

@thePunderWoman

@michael-small I'm not sure what's going on here, because nothing in this PR looks like it should introduce deps, but lint is showing circular dependencies. Can you take a look?

mmalerba last week
No worries, I appreciate that you're taking the time to check these things. 🙂 If you notice more little things and want to send a PR to the branch feel free and just @ me on it. (Though fair warning this is all still very in-development, and we might just immediately re-break the example with some API change 🤣)

I think it's because everyone who makes PRs is on the team and can opt which checks are done and whatnot.

Oh also thanks @kirjs who just approved this as I was typing this up lol

@michael-small michael-small deleted the sf/jsdoc-corrections branch June 5, 2025 13:47
@mmalerba
Copy link
Contributor

mmalerba commented Jun 5, 2025

Thanks for the cleanup!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kirjs kirjs kirjs approved these changes

@mmalerba mmalerba Awaiting requested review from mmalerba

Assignees
No one assigned
Labels
action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews area: docs Related to the documentation target: feature This PR is targeted for a feature branch (outside of main and semver branches)
Projects
None yet
Milestone
Backlog
Development

Successfully merging this pull request may close these issues.
5 participants
@michael-small @thePunderWoman @JeanMeche @kirjs @mmalerba