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.

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

[DOC]: Update LinearBoundaryStage Documentation #413

Closed
6 tasks done
mdemoret-nv opened this issue Oct 25, 2022 · 0 comments · Fixed by #418
Closed
6 tasks done

[DOC]: Update LinearBoundaryStage Documentation #413

mdemoret-nv opened this issue Oct 25, 2022 · 0 comments · Fixed by #418
Assignees
@drobison00
Labels
doc Improvements or additions to documentation

Comments

@mdemoret-nv
Copy link
Contributor

mdemoret-nv commented Oct 25, 2022 •
edited by drobison00
Loading

How would you describe the priority of this documentation request

Medium

Please provide a link or source to the relevant docs

https://docs.nvidia.com/morpheus/_modules/morpheus.stages.boundary.linear_boundary_stage.html

Describe the problems in the documentation

The linear boundary Ingress/Egress stages do not have the needed documentation for each stage. Missing information:

  • General description of what the stage does and how to use it
  • Example using the stage
  • Documentation of the input parameters
  • Documentation of the member variables and methods

(Optional) Propose a correction

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
  • I have searched the open documentation issues and have found no duplicates for this bug report
@mdemoret-nv mdemoret-nv added the doc Improvements or additions to documentation label Oct 25, 2022
@drobison00 drobison00 mentioned this issue Oct 26, 2022
Merged
@ghost ghost closed this as completed in #418 Nov 8, 2022
ghost pushed a commit that referenced this issue Nov 8, 2022
@drobison00
Add documentation to LinearBoundary stages (#418)
00124d1 
Resolves #413

Authors:
  - Devin Robison (https://github.com/drobison00)
  - Michael Demoret (https://github.com/mdemoret-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #418
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@drobison00 drobison00

Labels
doc Improvements or additions to documentation
Projects
Morpheus Boards
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation to LinearBoundary stages drobison00/devin-morpheus-public
2 participants
@drobison00 @mdemoret-nv