Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

docs($mdMenu): add documentation for $mdMenu #11649

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

codymikol
Copy link
Contributor

@codymikol codymikol commented Feb 22, 2019

currently there is no documentation.

Fixes: #11610

PR Checklist

Please check that your PR fulfills the following requirements:

  • The commit message follows our guidelines
  • Tests for the changes have been added or this is not a bug fix / enhancement
  • Docs have been added, updated, or were not required

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Enhancement
[x] Documentation content changes
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

Docs for $mdMenu are missing

Issue Number: #11610

What is the new behavior?

Added documentatiion

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@googlebot googlebot added the cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ label Feb 22, 2019
@Splaktar Splaktar self-assigned this Feb 26, 2019
@Splaktar Splaktar self-requested a review February 26, 2019 18:56
Copy link
Member

@Splaktar Splaktar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding this. It would be nice to also link the references to the service in https://material.angularjs.org/latest/api/directive/mdMenu to this service page similar to

* `md-virtual-repeat-container` provides the scroll container for
* <a ng-href="api/directive/mdVirtualRepeat">md-virtual-repeat</a>.

src/components/menu/js/menuServiceProvider.js Show resolved Hide resolved
@Splaktar Splaktar added this to the 1.1.14 milestone Feb 26, 2019
@Splaktar Splaktar added P3: important Important issues that really should be fixed when possible. in progress Mainly for in progress PRs, but may be used for issues that require multiple PRs labels Feb 26, 2019
@Splaktar
Copy link
Member

Please change Fixes: #11610 to Fixes #11610 in the commit message so that our changelog parsing will work properly.

@Splaktar
Copy link
Member

Just bumping this to get your attention 😄 It would be nice to get this into 1.1.14 which may go out in the next week or two.

@codymikol
Copy link
Contributor Author

I'll try to make these changes soon 🐔

@Splaktar Splaktar modified the milestones: 1.1.14, 1.1.15 Mar 18, 2019
@Splaktar Splaktar modified the milestones: 1.1.15, 1.1.16, 1.1.18, 1.1.19 Mar 29, 2019
@codymikol
Copy link
Contributor Author

codymikol commented Apr 20, 2019

I took a bit of a break from writing software over the past few weeks, I'll try and take a look at this over this coming week. 🐔

@Splaktar
Copy link
Member

Just a reminder that this only needs some minor tweaks before we can get it in.

@Splaktar Splaktar modified the milestones: 1.1.19, 1.1.20 May 30, 2019
@Splaktar Splaktar modified the milestones: 1.1.20, 1.1.21 Aug 15, 2019
currently there is no documentation.

Fixes: angular#11610
@Splaktar
Copy link
Member

@codymikol thank you for rebasing this. Do you think that you will have time to address the review feedback soon?

@codymikol
Copy link
Contributor Author

I finally had some time and after looking at it I realized that I'm pretty much documenting the directive usage in the service docs. I spent some time trying to wrap my head around using the actual service itself and it is definitely a different process entirely. Hopefully I'll be able to take some time and play around with the actual service in a codepen this week until I feel confident enough to write the documentation for its usage.

@Splaktar Splaktar modified the milestones: 1.1.21, 1.1.22 Oct 22, 2019
@Splaktar Splaktar removed this from the 1.1.22 milestone Mar 6, 2020
@Splaktar Splaktar added this to the 1.1.23 milestone Mar 6, 2020
@Splaktar Splaktar modified the milestones: 1.1.23, 1.2.1 May 6, 2020
@Splaktar Splaktar modified the milestones: 1.2.1, 1.2.2 Sep 23, 2020
@Splaktar Splaktar modified the milestones: 1.2.2, - Backlog Dec 21, 2020
@codymikol codymikol marked this pull request as draft April 10, 2024 20:17
@codymikol codymikol marked this pull request as ready for review April 10, 2024 20:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ in progress Mainly for in progress PRs, but may be used for issues that require multiple PRs P3: important Important issues that really should be fixed when possible. type: docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

menu: $mdMenu service documentation does not exist
3 participants